serverless framework
- lambda (+lambda-proxy)
- api gateway
Вот я хочу сгенерировать нормальную документацию (openapi, swagger, postman, не важно), чтоб было видно, какие входящие параметры принимает API (это есть) и какой результат вернется (обычно это json, типа 'success': true, data: ' модель таблицы sequelize').
Я вообще не смог найти вариантов это сделать. Кто-то сталкивался, как решили?
Можно попробовать tsoa - https://github.com/lukeautry/tsoa Позволяет сгенерить OpenAPI спеку из TypeScript кода. Сразу оговорюсь что для serverless приложений не пробовал это использовать.
Спасибо, учту. Но у меня, конечно же, простой js:))
я пользовалась этими пакетами "swagger-jsdoc" "swagger-ui-express" но к сожалению они магию не делают - сначала ты руками берешь и описываешь вход/выход API эндпоинтов (в формате swagger) в Jsdoc комментах в коде над каждым контроллером а потом просто swagger-jsdoc собирает все эти jsdoc кусочки в один большой swagger файл и swagger-ui-express позволяет сгенерить удобный UI. трудозатраты в итоге такие же как просто сидеть писать swagger файл, просто за счет того что пишешь части swaggerа в комментах в коде - потом больше вероятность не забыть поправить когда поменялось API
У нас appsync (тоже сервелесс на лямбдах). Так что, графкл - уже сам по себе документация...
а что, сейчас сваггер дефинишен с Api Gateway уже не выгружается?
Выгружается, но не показывает что будет в response :)
Обсуждают сегодня