Всем привет! Есть следующее: - nodejs - sequlelize models (много таблиц описаны) -

serverless framework
- lambda (+lambda-proxy)
- api gateway

Вот я хочу сгенерировать нормальную документацию (openapi, swagger, postman, не важно), чтоб было видно, какие входящие параметры принимает API (это есть) и какой результат вернется (обычно это json, типа 'success': true, data: ' модель таблицы sequelize').

Я вообще не смог найти вариантов это сделать. Кто-то сталкивался, как решили?

6 ответов

20 просмотров

Можно попробовать tsoa - https://github.com/lukeautry/tsoa Позволяет сгенерить OpenAPI спеку из TypeScript кода. Сразу оговорюсь что для serverless приложений не пробовал это использовать.

Me👀- Автор вопроса
Vladimir Shiryaev
Можно попробовать tsoa - https://github.com/lukeau...

Спасибо, учту. Но у меня, конечно же, простой js:))

я пользовалась этими пакетами "swagger-jsdoc" "swagger-ui-express" но к сожалению они магию не делают - сначала ты руками берешь и описываешь вход/выход API эндпоинтов (в формате swagger) в Jsdoc комментах в коде над каждым контроллером а потом просто swagger-jsdoc собирает все эти jsdoc кусочки в один большой swagger файл и swagger-ui-express позволяет сгенерить удобный UI. трудозатраты в итоге такие же как просто сидеть писать swagger файл, просто за счет того что пишешь части swaggerа в комментах в коде - потом больше вероятность не забыть поправить когда поменялось API

У нас appsync (тоже сервелесс на лямбдах). Так что, графкл - уже сам по себе документация...

а что, сейчас сваггер дефинишен с Api Gateway уже не выгружается?

Me👀- Автор вопроса
R V
а что, сейчас сваггер дефинишен с Api Gateway уже ...

Выгружается, но не показывает что будет в response :)

Похожие вопросы

Обсуждают сегодня

Добрый вечер, Пока не совсем понимаю как наладить общение между телеграм ботом и ПО для работы с сим боксом. По самому боту так понял: - Нужен некий баланс, который можно поп...
Magic
6
Объясните, пожалуйста, почему компилятор ругается на использование в условии неинициализированной переменной: int x; Task.Run(async () => { x = await somefunc(); }).Wait...
Александр
5
Всем привет. Ребята, подскажите, пожалуйста. у ботов есть ограничение на отправку сообщений - 30 сообщений в секунду, эти ограничения накладываются на все сообщения? или на со...
Artem Stormageddon
4
1. https://www.kaggle.com/code/ahmadrezagholami2001/housing-estimation-linear-regression 2. https://www.kaggle.com/code/ahmadrezagholami2001/uncovering-quality-in-wines-logis...
Ahmadreza
1
Блин, ребята, сори за тупые вопросы. А можно ли как-то открыть вебапку по нажатию на кнопку в меню(которое появляется слева, команды)?
Artem Stormageddon
3
Коллеги, может знает кто, можно ли цвет бейджа счётчика в BackendMenu менять без бубнов?
Alex Blaze
3
а плаксы из-под питона умеют только в комфортных условиях что-то выдавить из себя?)
Lencore
9
Привет!) Кто как юзает переменные в строках?) Чисто ради интереса Вот так: echo "У меня {$bananasAmount} бананов"; Или вот так: echo "У меня ${bananasAmount} бананов";
Виталий
3
Но, может, есть уже проверенная? Наши требования такие: 1. Сообщения должны приходить из Инста в CRM оду 2. Должна быть возможность подключить несколько экаунтов Инстаграм. Р...
Alexander Sharoiko MSE / Александр Шаройко
13
разработчик ботов скидывает портфолио, боты которые он уже создал. А вот как узнать что это именно он их создал?
Gosudar
4
Карта сайта