Друзья и коллеги, тут ещё одна тема для обсуждения подоспела. Она была давно в планах, но всё не было подходящего контекста.
Первоначально хотел поговорить про OpenAPI 3.0 (и его поддержку на примере Swagger), но в процессе подготовки обнаружилось несколько важных вопросов, без обсуждения которых документация по проекту не будет полной, а именно генерация ER-диаграмм по ORM-модели и создание печатной версии руководства пользователя непосредственно в процессе сборки из Markdown.
Мы рассмотрим автоматическую генерацию OpenAPI 3.0 JSON из проектов Dart Aqueduct (обсудим и собственные типы входных и выходных структур), aiohttp (python), Swagger-PHP (PHP). Относительно баз данных изучим несколько подходов к созданию ER-диаграмм из описаний ORM для php, python и dart (Aqueduct ORM). Ну и обсудим напоследок, как можно создать печатный вариант документации или руководства пользователя, в процессе сборки в gitlab CI.
Обсуждение состоится на канале Youtube лаборатории завтра (07.04.2018) в 13:00. Разбирать будем на практических примерах, так чтобы сразу собрать необходимый и достаточный пакет документации. Приходите, задавайте вопросы, предлагайте идеи.