Генерация документов swagger из машинописных интерфейсов

Question

Я использую swager-jsdoc для документирования всех DTO приложения.

Мне было интересно, есть ли способ автоматически генерировать документы swagger из интерфейсов машинописи.

У меня их много в проекте, а также множество схем и моделей мангустов.Становится утомительно держать их в синхронизации.С другой стороны, я не хочу использовать инструменты генерации чванства.Я предпочитаю восходящий подход.

Приветствия

Answer 1

Другая опция для tsoa - это контроллеры маршрутизации + контроллеры маршрутизации-openapi .Основное различие между ними (AFAIK) заключается в том, что tsoa зависит от генерации кода, тогда как routing-controllers работает полностью во время выполнения.Оба метода имеют свои преимущества: tsoa может, например, использовать более богатые метаданные (например, комментарии к коду), тогда как с routing-controllers мы можем пропустить этап генерации.Я рекомендую проверить оба!

Еще одна опция - https://github.com/YousefED/typescript-json-schema,, которая генерирует химию JSONS из интерфейсов Typescript;После того, как вы определили свои модели в JSON Schema, вы не слишком далеки от спецификации OpenAPI.

Answer 2

Да, вы можете легко генерировать документы Swagger и OpenAPI из типов TypeScript, используя tsoa .В файле readme содержится вся информация о настройке, которая понадобится вам для начала использования.Он совместим с экспресс, хапи, коа и другими:

https://github.com/lukeautry/tsoa

---

(Полная прозрачность: я один из сопровождающих tsoa. ​​Но я был первым потребителемtsoa, ​​и я считаю, что это отличный продукт ... вот почему я попросил помочь сохранить его! :))