Backend > Docs > Gerar documentação detalhada (Swagger) dos endpoints [módulo: Projects]

[PedroFDiniz]

OVERVIEW

• Na ideia de aprimorar a apresentação de nosso projeto, é interessante que uma boa documentação seja escrita.
• Como houve uma refatoração massiva do projeto, toda a documentação existente no README.md está desatualizada. Necessitamos de uma nova documentação especificamente das rotas da API Rest, para facilitar o trabalho de todos os desenvolvedores atuais e futuros que venham a usar estes endpoints.
• Com isto em mente, sugere-se aqui a criação de um arquivo projects.swagger.ts dentro da pasta do módulo de projetos, que detalhará todos os detalhes da rota, seguindo o padrão Swagger OpenAPI v3, e que eventualmente deverá ser importado por um outro arquivo geral de documentação do projeto.

TASK

• Mapear todas as rotas do módulo no padrão Swagger, testá-las pelo Insomnia ou Postman;
• Indicar exigências de body, header, e params das requisições enviadas a estas rotas;
• Gerar um arquivo de documentação projects.swagger.ts;
• Permitir a importação das informações das rotas e das informações dos objetos sendo usados nestas rotas;