Swagger для системного аналитика: вручную, через ChatGPT или конструктор — что быстрее?
Инара Гаврилина
0:00 / 0:00
Swagger для системного аналитика: вручную, через ChatGPT или конструктор — что быстрее?
50 просмотров · 7 дней назад
Инара Гаврилина
26 подписчиков
50 просмотров · 7 дней назад
Бот для получения доступа к конструктору https://t.me/inara_sa_bot
Как быстро и без ошибок писать документацию к API в Swagger (OpenAPI)? Показываю три способа на реальном эндпоинте POST /cars: вручную в YAML, через промпт в ChatGPT и в моём конструкторе, где промпт вообще не нужен.
В видео:
• из каких 7 пунктов состоит описание любого эндпоинта: метод, путь, query-параметры, заголовки, тело запроса, тело ответа, ошибки
• как выглядит документация, написанная руками, и где в ней легко ошибиться
• как собрать промпт для ChatGPT по этим 7 пунктам и почему нейросеть может выдумать лишнее
• как собрать ту же документацию в конструкторе: сразу получаете превью Swagger UI и готовый YAML
• сравнение трёх способов: время, риск ошибок, нужен ли навык