Swagger

Instalação

Instalação do pacote

yarn add swagger-ui-express

Instalação das tipagens

yarn add @types/swagger-ui-express -D

Configuração do Servidor

// src/swagger.json
{
"openapi": "3.0.0",
"info": {
"title": "API Documentation",
"description": "",
"version": "1.0.0",
"contact": "leo@webid.net.br"
}
}
// src/app.ts
import swaggerUi from 'swagger-ui-express';
import swaggerFile from './swagger.json';
class App {
// ...
constructor() {
// ...
this.express.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerFile));
}
// ...