Я использую swager-jsdoc для документирования всех DTO приложения.
Мне было интересно, есть ли способ автоматически генерировать документы swagger из интерфейсов машинописного текста.
У меня их много в проекте, а также много схем и моделей мангустов. Становится утомительно синхронизировать их. С другой стороны, я не хочу использовать инструменты генерации чванства. Я предпочитаю подход снизу вверх.
Ваше здоровье
Другим вариантом tsoa является контроллеры маршрутизации + контроллеры маршрутизации-openapi . Основное различие между ними (AFAIK) заключается в том, что tsoa полагается на генерацию кода, тогда как routing-controllers полностью работает во время выполнения. Оба метода имеют свои преимущества: tsoa может, например. использовать более богатые метаданные (например, комментарии к коду), тогда как с routing-controllers мы можем пропустить этап генерации. Моя рекомендация - проверить оба!
Да, вы можете легко создавать документы Swagger и OpenAPI из типов TypeScript, используя tsoa. Файл readme содержит всю информацию об установке, которая вам потребуется, чтобы начать его использовать. Он совместим с экспресс, хапи, коа и другими:
https://github.com/lukeautry/tsoa
(Полная прозрачность: я один из сопровождающих tsoa. Но я был первым потребителем tsoa, и я считаю, что это отличный продукт... поэтому я попросил помочь его поддерживать! :))
Другой вариант — использовать https://www.npmjs.com/package/ts-to-openapi для создания схем Swagger из интерфейсов.
Пример: Учитывая приведенный ниже пользовательский интерфейс:
export interface User {
name: string;
email: string;
nickname?: string;
}
В терминале выполните следующую команду:
npx ts-to-openapi -f User.ts -t User >> User.ts
После этого ваш пользователь интерфейса будет обновляться, как показано ниже:
export interface User {
name: string;
email: string;
nickname?: string;
}
/**
* @swagger
* components:
* schemas:
* User:
* additionalProperties: false
* properties:
* email:
* type: string
* name:
* type: string
* nickname:
* type: string
* required:
* - name
* - email
* type: object
*/
