Как документировать API через Swagger/OpenAPI в Node.js?

Middle
281 просмотров
AFK Offer AI

swagger-jsdoc генерирует OpenAPI spec из JSDoc комментариев. swagger-ui-express отдаёт UI. В NestJS: @nestjs/swagger с декораторами (@ApiTags, @ApiOperation, @ApiResponse). Альтернативы: TypeDoc для документации кода. ts-rest генерирует документацию из контрактов. Postman коллекции. Лучшие практики: документация рядом с кодом (не отдельный файл), примеры запросов/ответов, описание кодов ошибок, authentication schemes. В production добавляй basic auth на /api-docs.

Следующий вопрос

Как работает модуль path в Node.js?