Documentação da interface da API gerada (swagger)

[jtonynet]

IMPORTANTE: A partir dessa tarefa concluída, qualquer alteração que signifique mudanças de contrato com interface externa da API REST e validação de seus recursos, deverão contemplar atualização do Swagger bem como do Postman collection quando pertinente. Da mesma maneira que teste "caminho feliz" deve ser OBRIGATÓRIO

• Requisitos não funcionais:
  • Requisitos obrigatórios
    • Deve usar o padrão de API REST (HTTP/JSON);
    • Documentação da interface da API gerada (swagger, open-api, RAML ou postman);

Sabendo que o desenvolvimento desde o inicio respeitou as guidelines REST de Swager APIs

• Implementar Swagger
• Exportar postman collection

[jtonynet]

• Especificação OpenAPI 3
• Guia passo a passo para "anotations swagger"
• Mais sobre anotations $ref
• pacote swagger express