💻 Sobre o desafio

Nesse desafio, você deverá criar uma aplicação para treinar o que aprendeu até agora no Node.js!

Utilizando uma aplicação já funcional como base, realize a documentação das rotas com o Swagger.

Template da aplicação

Nesse desafio você deve utilizar como template o seu código final desenvolvido em:

Desafio 01 - Introdução ao SOLID

Preparando ambiente para documentação

Como visto na aulas, você precisa configurar o ambiente para a documentação da sua aplicação. As etapas que você deve seguir é:

• Instalar a lib swagger-ui-express;
• Criar um arquivo JSON para você escrever a documentação na especificação OpenAPI 3.0;
• Instanciar na sua aplicação uma rota api-docs que vai servir a sua documentação.

O que eu devo documentar?

A documentação deve servir como uma descrição das entradas e saídas da sua API. Abaixo sugerimos os principais pontos que você deve documentar:

• Informações gerais da API (nome, descrição, etc.);
• Rotas;
• Parâmetros;
• Corpo da Requisição;
• Respostas de sucesso;
• Respostas de erro;