From 68a6b2f5769bfcc8bbf8524f28517b07278006d1 Mon Sep 17 00:00:00 2001 From: CleilsonAndrade Date: Mon, 19 Aug 2024 12:26:48 -0300 Subject: [PATCH] docs(readme): separated method in endpoints --- README.md | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a3575c5..75c927b 100644 --- a/README.md +++ b/README.md @@ -54,17 +54,17 @@ Template inicial para projetos em [**NestJS**](https://nestjs.com/) pré-configu - **Swagger themes** # 📍 Endpoints -| Endpoint | Resumo | Autenticação | Role -|----------------------|------------------------------------------------------|--------------------------|---------------------- -| GET / | Responsável por ser o endpoint inicial | Não | * -| GET /auth/login | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim | * -| POST /users | Responsável por cadastrar o usuário | Não | * -| GET /users | Responsável por listar todos os usuários com paginação | Sim | * -| GET /users/:id | Responsável por buscar usuário, informando o ID | Sim | * -| PATCH /users/:id | Responsável por atualizar as informações de um usuário, informando o ID | Sim | * -| DELETE /users/:id | Responsável por desabilitar um usuário, informando o ID | Sim | * -| GET /health | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim | * -| GET /docs | Responsável por servir a documentação dos recursos da API | Não | * +| Método | Endpoint | Resumo | Autenticação | Role +|--------|----------------------|------------------------------------------------------|--------------------------|---------------------- +GET | / | Responsável por ser o endpoint inicial | Não | * +GET | /auth/login | Responsável por autenticar o usuário, gerando o Bearer Token *JWT* | Sim | * +POST | /users | Responsável por cadastrar o usuário | Não | * +GET | /users | Responsável por listar todos os usuários com paginação | Sim | * +GET | /users/:id | Responsável por buscar usuário, informando o ID | Sim | * +PATCH | /users/:id | Responsável por atualizar as informações de um usuário, informando o ID | Sim | * +DELETE | /users/:id | Responsável por desabilitar um usuário, informando o ID | Sim | * +GET | /health | Responsável por utilizar o Terminus para consulta dos recursos de uso da API | Sim | * +GET | /docs | Responsável por servir a documentação dos recursos da API | Não | * # 🚀 Instalação ```bash