Skip to content

Commit

Permalink
Merge pull request #25 from CleilsonAndrade/separated-method-in-endpo…
Browse files Browse the repository at this point in the history
…ints

docs(readme): separated method in endpoints
  • Loading branch information
CleilsonAndrade authored Aug 19, 2024
2 parents d7bf293 + 68a6b2f commit 1360f94
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,17 +54,17 @@ Template inicial para projetos em [**NestJS**](https://nestjs.com/) pré-configu
- **Swagger themes**

# 📍 <span id="endpoints">Endpoints</span>
| Endpoint | Resumo | Autenticação | Role
|----------------------|------------------------------------------------------|--------------------------|----------------------
| <kbd>GET / </kbd> | Responsável por ser o endpoint inicial | Não | *
| <kbd>GET /auth/login </kbd> | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim | *
| <kbd>POST /users </kbd> | Responsável por cadastrar o usuário | Não | *
| <kbd>GET /users </kbd> | Responsável por listar todos os usuários com paginação | Sim | *
| <kbd>GET /users/:id </kbd> | Responsável por buscar usuário, informando o ID | Sim | *
| <kbd>PATCH /users/:id </kbd> | Responsável por atualizar as informações de um usuário, informando o ID | Sim | *
| <kbd>DELETE /users/:id </kbd> | Responsável por desabilitar um usuário, informando o ID | Sim | *
| <kbd>GET /health </kbd> | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim | *
| <kbd>GET /docs </kbd> | Responsável por servir a documentação dos recursos da API | Não | *
| Método | Endpoint | Resumo | Autenticação | Role
|--------|----------------------|------------------------------------------------------|--------------------------|----------------------
<kbd>GET</kbd> | <kbd>/</kbd> | Responsável por ser o endpoint inicial | Não | *
<kbd>GET</kbd> | <kbd>/auth/login</kbd> | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim | *
<kbd>POST</kbd> | <kbd>/users</kbd> | Responsável por cadastrar o usuário | Não | *
<kbd>GET</kbd> | <kbd>/users</kbd> | Responsável por listar todos os usuários com paginação | Sim | *
<kbd>GET</kbd> | <kbd>/users/:id</kbd> | Responsável por buscar usuário, informando o ID | Sim | *
<kbd>PATCH</kbd> | <kbd>/users/:id</kbd> | Responsável por atualizar as informações de um usuário, informando o ID | Sim | *
<kbd>DELETE</kbd> | <kbd>/users/:id</kbd> | Responsável por desabilitar um usuário, informando o ID | Sim | *
<kbd>GET</kbd> | <kbd>/health</kbd> | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim | *
<kbd>GET</kbd> | <kbd>/docs</kbd> | Responsável por servir a documentação dos recursos da API | Não | *

# 🚀 <span id="instalação">Instalação</span>
```bash
Expand Down

0 comments on commit 1360f94

Please sign in to comment.