Aqui está o README que explica cada endpoint da sua API Laravel com JWT. Para testar cada endpoint, basta copiar a URL correspondente e utilizar ferramentas como o Postman ou o cURL para fazer as requisições HTTP. Lembre-se de realizar as ações de autenticação (login) para obter o token JWT e incluí-lo no cabeçalho Authorization
das requisições protegidas por JWT.
Esta é uma API Laravel com autenticação JWT para gerenciar usuários, médicos, pacientes e cidades!clear
O Tipo do Token é Bearer lembre-se de validar seu user e pegar o token para acessar as telas que precisam de validação
- Nome da API: Laravel API + JWT
- Versão: 1.0.1
- URL:
/
- Método:
GET
- Descrição: Retorna informações básicas da API, como nome e versão.
- URL:
/register
- Método:
POST
- Descrição: Cria um novo usuário no sistema. Recebe
name
,email
epassword
no corpo da requisição.
- URL:
/login
- Método:
POST
- Descrição: Realiza a autenticação do usuário. Recebe
email
epassword
no corpo da requisição e retorna um token JWT válido em caso de sucesso.
- URL:
/medicos
- Método:
GET
- Descrição: Retorna uma lista paginada de todos os médicos cadastrados no sistema.
- URL:
/medico/{id}
- Método:
GET
- Descrição: Retorna os detalhes de um médico específico com base no ID fornecido.
- URL:
/cidades
- Método:
GET
- Descrição: Retorna uma lista paginada de todas as cidades cadastradas no sistema.
- URL:
/cidades/{id_cidade}/medicos
- Método:
GET
- Descrição: Retorna uma lista de médicos associados a uma cidade específica com base no ID da cidade fornecido.
As seguintes rotas requerem autenticação JWT (Bearer Token) no cabeçalho Authorization
:
- URL:
/users
- Método:
GET
- Descrição: Retorna uma lista paginada de todos os usuários cadastrados no sistema. Requer autenticação JWT.
- URL:
/user/{id}
- Método:
GET
- Descrição: Retorna os detalhes de um usuário específico com base no ID fornecido. Requer autenticação JWT.
- URL:
/user/{id}
- Método:
DELETE
- Descrição: Deleta um usuário específico com base no ID fornecido. Requer autenticação JWT.
- URL:
/user/{id}
- Método:
PATCH
- Descrição: Atualiza um usuário específico com base no ID fornecido. Requer autenticação JWT.
- URL:
/me
- Método:
POST
- Descrição: Retorna os detalhes do usuário autenticado. Requer autenticação JWT.
- URL:
/logout
- Método:
POST
- Descrição: Realiza o logout do usuário autenticado e invalida o token JWT. Requer autenticação JWT.
- URL:
/pacientes
- Método:
GET
- Descrição: Retorna uma lista paginada de todos os pacientes cadastrados no sistema. Requer autenticação JWT.
- URL:
/paciente/{id}
- Método:
GET
- Descrição: Retorna os detalhes de um paciente específico com base no ID fornecido. Requer autenticação JWT.
- URL:
/pacientes/{id_paciente}
- Método:
POST
- Descrição: Atualiza um paciente específico com base no ID fornecido. Requer autenticação JWT. Permite atualizar apenas os campos
nome
ecelular
ecpf
. Observação: CPF precisa ser válido ! link: https://www.4devs.com.br/gerador_de_cpf
- URL:
/pacientes
- Método:
POST
- Descrição: Cria um novo paciente no sistema. Requer autenticação JWT. Recebe
nome
,celular
ecpf
no corpo da requisição. Observação: CPF precisa ser válido ! link: https://www.4devs.com.br/gerador_de_cpf
- URL:
/paciente/{id}
- Método:
DELETE
- Descrição: Deleta um paciente específico com base no ID fornecido. Requer autenticação JWT.
- URL:
/medicos/{id_medico}/pacientes
- Método:
GET
- Descrição: Retorna uma lista de pacientes associados a um médico específico com base no ID do médico fornecido. Requer autenticação JWT.
- URL:
/medicos
- Método:
POST
- Descrição: Cadastra um novo médico no sistema. Requer autenticação JWT. Recebe
nome
,especialidade
ecidade_id
no corpo da requisição.
- URL:
/medicos/{id_medico}/pacientes
- Método:
POST
- Descrição: Vincula um paciente a um médico específico com base no ID do médico fornecido. Requer autenticação JWT. Recebe
paciente_id
emedico_id
no corpo da requisição.
Espero que esse README o ajude a entender os endpoints da sua API Laravel com JWT. Lembre-se de ajustar as configurações de autenticação, como a geração de tokens JWT e a lógica de permissões, para garantir a segurança e o controle adequado dos recursos da API.