Doctor

Documentação

Índice

• Guia de Desenvolvimento
  • Autorizações Disponíveis
• Referência da API REST
  • Códigos de status HTTP
• Campos
• Inserir Item
  • Not Allowed
• Listar Items
  • Success
• Detalhar Item
  • Success
  • Not Found
• Atualizar Item
  • Not Allowed
• Deletar Item
  • Not Allowed

Guia de Desenvolvimento

Autorizações Disponíveis

AUTHORIZATION	Bearer	URL
Token	auth	/api-token-auth/

Referência da API REST

Códigos de status HTTP

• 200 Successful request
• 401 Unauthorized
• 404 Not Found
• 405 Not Allowed

---

Campos

Nome	Tipo	Tamanho máximo	Em branco/Nulo	Descrição
name	String	55	False/False	Nome do médico.
crm	Integer	-	False/False	Número de CRM do médico.
email	String	100	/	E-mail do médico.
phone	String	15	/	Número de telefone do médico.
specialty	String	-	True/True	Especialidade do médico.

Inserir Item

POST /medicos/

Insere um item e retorna os valores inseridos.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Listar Items

GET /medicos/

Retorna uma lista com todos os itens cadastrados.

Success

• Status Code: 200

Resposta de exemplo:

[
  {
    "id": "Integer",
    "name": "String",
    "crm": "Integer",
    "email": "String",
    "phone": "String",
    "specialty": "String",
  },
  {
    "id": "Integer",
    "name": "String",
    "crm": "Integer",
    "email": "String",
    "phone": "String",
    "specialty": "String",
  },
  // ...
]

Detalhar Item

GET /medicos/:id

Retorna o detalhe de um item.

Success

• Status Code: 200

Resposta de exemplo:

{
  "id": "Integer",
  "name": "String",
  "crm": "Integer",
  "email": "String",
  "phone": "String",
  "specialty": "String",
}

Not Found

• Status Code: 404

Resposta de exemplo:

{
  "detail": "Não encontrado."
}

Atualizar Item

PUT /medicos/:id

Atualiza um item e retorna os valores alterados.

Not Allowed

• Status Code: 405

Resposta de exemplo:

Deletar Item

DELETE /medicos/:id

Deletar um item cadastrado.

Not Allowed

• Status Code: 405

Resposta de exemplo: