Desafio 05 🚀
Ignite - Rocketseat - Trilha Node js
💻 Descrição
Este desafio tinha como finalidade documentar a API criada no desadio anterior (desafio 05), usando Swagger.
🗂 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;
- Exemplos.
📝 Clonagem e uso
Para clonar o repositório rode https://github.com/JackssonAndrey/ignite-desafio-05.git no seu terminal.
Entre na pasta do projeto e rode yarn no seu terminal para instalar as dependências.
Uso
Com as dependências instaladas rode yarn dev para subir o servidor. Para rodar os testes rode yarn test.