API Províncias de Angola

GitHub

Tratando erros

Introdução

A API utiliza os seguintes códigos de status para indicar o sucesso ou falha de uma requisição:

  • 200 OK: A requisição foi bem-sucedida.
  • 404 Not Found: Recurso não encontrado.
  • 500 Internal Server Error: Ocorreu um erro no servidor.

Exemplos

Requisição bem sucedida

Exemplo de requisição bem sucedida: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias
{
"success": true,
"code": 200,
"message": "Sucesso",
"data": [
//...
]
}

Recurso não encontrado

Exemplo de requisição de recurso inesistente: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias/new-york
{
"success": false,
"code": 404,
"message": "Província não encontrada",
"data": []
}

Erro inesperado no servidor

Exemplo de requisição com erro inesperado no servidor: 

// GET https://angolaprovinciasapi.ggwp.com.br/api/v1/provincias
{
"success": false,
"code": 500,
"message": "Erro ao recuperar províncias",
"data": []
}