Respostas HTTP

Respostas HTTP

Os possíveis códigos de respostas HTTP são:

Ok

200

O código 200 é retornado em todas as requisições que obtiverem sucesso com qualquer método HTTP.

---

Recurso não encontrado

404

A resposta do tipo Resource not found será recebida somente em endpoints com paths do tipo {id}.

Exemplo

JSON

{
  "status": 404,
  "error": 404,
  "messages": {
    "error": "Profile not found"
  }
}

---

Não autorizado

401

A resposta do tipo Unauthorized será recebida em qualquer endpoint que requer token de autenticação.

Exemplo

JSON

{
  "status": 401,
  "error": 401,
  "messages": {
    "error": "Unauthorized"
  }
}

---

Não processado

422

A resposta do tipo Unprocessable será recebida sempre que houver erro de validação dos campos da requisição. O retorno será um objeto JSON com a mensagem da validação.

Exemplo

JSON

{
  "status": 422,
  "code": 422,
  "messages": {
    "name": "The name field is required.",
    "cpf": "The cpf must be a valid number"
  }
}

---

Erro interno do servidor

500

A resposta do tipo Server error será recebida sempre que houver erro interno da aplicação. O retorno será um objeto JSON com a mensagem de erro interno do servidor.

Exemplo

JSON

{
  "status": 500,
  "code": 500,
  "messages": {
    "error": "Internal Server Error"
  }
}