Readme template for my repos

template-readme.md

Título

Resumo do que se trata o repositório.

📕 Sumário

1. Preview
2. O que eu aprendi de novo nesse projeto
3. Tecnologias usadas
4. Para rodar
5. Documentação

1. 😲 Preview

Caso tenha algum preview de como ficou...

2. 🎓 O que eu aprendi de novo nesse projeto

• Breve resumo do que eu aprendi...
• Exemplo: Aprendi a separar o html do css;

3. 💻 Tecnologias usadas

• Tecnologias que foram usadas no projeto

4. 🎉 Para rodar o projeto

1. Instale todas es tec's usadas junto do Node JS:

   npm install
   

2. Rode o aplicativo

   npm run dev
   

3. Você precisará de uma ferramente de teste de requisições como o Postman ou Insomnia

4. Digite localhost:3001 e siga a minha tentativa de documentação para usar a api

5. 📖 Documentação

De qual entidade é a rota

Método

Rota

Descrição	Valor
Autenticação	Requerido
Parâmetros	Não requerido
Status code	200 (OK)

---

Exemplo

Users

GET

/users

Descrição	Valor
Autenticação	Requerido
Parâmetros	Não requerido
Status code	200 (OK)

/users/id

Descrição	Valor
Autenticação	Requerido
Parâmetros	Id do usuário
Status code	200 (OK)

POST

/users

Descrição	Valor
Autenticação	Não Requerido
Parâmetros	Não Requerido
Status code	200 (OK) ou 400 (Bad Request)

PUT

/users

Descrição	Valor
Autenticação	Requerido
Parâmetros	Não Requerido
Status code	200 (OK) ou 400 (Bad Request)

DELETE

/users

Descrição	Valor
Autenticação	Requerido
Parâmetros	Não Requerido
Status code	200 (OK) ou 400 (Bad Request)

Autor

Gustavo 😎