Полезный Swagger

Вы бывший фронтендер и сегодняшний фулл-стак, писать бэкенд уже как-то научились, но форматировать типы для ручек и подключать их самостоятельно лень? Спасает Swagger.

Я постоянно обращаюсь к нему когда:

• Добавляю новую ручку
• Меняю что-то в ныне существующих
• Перепроверяю спецификации

Только не подумайте что это история про «Посмотри в Swagger и перенеси руками», нет, не побоюсь сказать — это прошлый век. Сейчас механизм следующий:

Скачиваем openapi.json из Swagger-спецификации (файлик можно найти прямо сразу после названия вашего сервиса, отображаемого в Swagger).

Далее на основе этого файла идем в фронтенд и отдаем его ИИшке — точечно или полностью в зависимости от контекста и цели. Например, вам нужно перенести только одну группу маршрутов из Swagger, так и поставьте задачу: «Давай перенесем маршруты по представленной спецификации из файла».

Вам остается следить, как ИИ организует лишь вашу структуру методов: положит ли он их туда, куда нужно, сможет ли заменить существующие моковые методы на настоящие и так далее, чтобы не плодить мертвый код на пустом месте.

Если что-то пошло не так

Рассмотрим еще кейс: вы вроде все настроили, но данные не отправляются, летят не так — не проблема. Есть HAR-файлы, выкачиваем их из наших девтулзов и скармливаем также ИИ, смотрим, как он их разберет, фиксим, если необходимо.

Так ИИ получит доступ ко всей информации по запросу, но и «щепетильные» данные тоже могут оказаться в руках вашего помощника, за этим нужно следить.

https://images.boosty.to/image/e4b9fdc7-146f-4111-8014-8786efd31eb0

Так мы снимаем с себя обязательства ведения типов и ручного перевода ручек, что, лично меня, всегда бесило. Поэтому советую каждому иметь на своем бэке Swagger или другую спецификацию, которая окажется вашей «палочкой-выручалочкой» при построении взаимодействия с бэком на фронте.