Signup

Documentação

Índice

• Guia de Desenvolvimento
• Referência da API REST
  • Códigos de status HTTP
• Fields
• Inserir Item
  • Success
  • Bad Request
• Listar Items
  • Method Not Allowed
• Detalhar Item
  • Method Not Allowed
• Atualizar Item
  • Method Not Allowed
• Deletar Item
  • Method Not Allowed

Guia de Desenvolvimento

Obs: Apenas o POST para cadastro retorna Success, as demais rotas estão configuradas como não permitidas.

Referência da API REST

Códigos de status HTTP

• 200 Successful request
• 400 Bad request
• 405 Method Not Allowed

---

Fields

Nome	Tipo	Descrição
first_name	String	Nome do paciente.
last_name	String	Sobrenome do paciente.
email	String	Endereço de e-mail do usuário.
password	String	Senha de autenticação do usuário.

Inserir Item

POST /users/

Insere um item e retorna os valores inseridos.

Success

• Status Code: 201

Dados de exemplo:

{
  "first_name": "String",
  "last_name": "String",
  "email": "String",
  "password": "String",
}

Resposta de exemplo:

{}

Bad Request

• Status Code: 400

Resposta de exemplo:

{
  "email": [
    "Este campo é obrigatório."
  ],
  "password": [
    "Este campo é obrigatório."
  ]
}

Listar Items

GET /users/

Retorna uma lista com todos os itens cadastrados.

Method Not Allowed

• Status Code: 405

Resposta de exemplo:

{
  "status": 405
}

Detalhar Item

GET /users/:id

Retorna o detalhe de um item.

Method Not Allowed

• Status Code: 405

Resposta de exemplo:

{
  "status": 405
}

Atualizar Item

PUT /users/:id

Atualiza um item e retorna os valores atualizados.

Method Not Allowed

• Status Code: 405

Resposta de exemplo:

{
  "status": 405
}

Deletar Item

DELETE /users/:id

Deletar um item cadastrado.

Method Not Allowed

• Status Code: 405

Resposta de exemplo:

{
  "status": 405
}