swagger-genx

Swagger-genx é uma dependência desenvolvida para facilitar a construção de mapeamentos de rotas de APIs com o Swagger em projetos Node.js com apenas TypeScript, eliminando a necessidade de passar por muitos processos de configuração de rotas dentro do projeto.

Essa dependência está em seus primeiros passos. Por ser uma dependência muito jovem, ela está limitada em alguns casos e com poucos testes, nessa versão ainda faltam funcionalidades de customização do documento swagger gerado.

Instalação

Para instalar, basta inserir usando NPM:

  npm install swagger-genx

Como funciona

No seu projeto, é necessário que siga a estrutura de arquivos, onde todos os arquivos estarão dentro da pasta /src.

Uso inicial da dependência:

import { GenerateInit } from 'swagger-genx'
import express from 'express';

var app = express();

GenerateInit(app, {
    security: [""],
    host: "https://localhost:3000",
    schemes: ["https"],
    document: {
        title: "Swagger-GenX",
        description: "descrição"
    }
}, () => {
    app.listen(3000, () => {
        console.log("Express com swagger-genx")
    })
})

Rodando a api, a dependencia inicialmente irá avaliar o index.ts, vendo os controladores inseridos e coletando cada nome do controlador para serem registrados como sessões no Swagger no final do processo.