Regras Gerais
Cada API DEVE usar os Códigos de status HTTP apropriados para comunicar o resultado de uma operação de solicitação.
| Código | Nome | Descrição |
|---|---|---|
| 200 | OK | Resposta a uma ação bem-sucedida da API REST. |
| 201 | Created | Indica que a ação foi bem-sucedida e um ou mais recursos foram criados. |
| 204 | No Content | Indica que a ação foi bem-sucedida e não há conteuído a ser encaminhado na resposta. |
| 400 | Bad Request | A solicitação está malformada, como um erro no formato do corpo da mensagem. |
| 401 | Unauthorized | ID/senha de autenticação incorretos ou inexistentes. |
| 403 | Forbidden | Usado quando a autenticação foi bem-sucedida, mas o usuário autenticado não tem permissão para acessar o recurso solicitado. |
| 404 | Not Found | Quando um recurso inexistente é solicitado. |
| 405 | Method Not Allowed | A verificação de erro para um método HTTP inesperado. Por exemplo, a API REST está esperando HTTP GET, mas HTTP PUT está sendo usado. |
| 409 | Conflict | A solicitação não pode ser concluída por um conflito com com o estado atual do recurso sendo processado. |
| 429 | Too Many Requests | O erro é usado quando pode haver um ataque DOS detectado ou a solicitação é rejeitada devido ao Rate Limit. |
| 500 | Internal Server Error | O servidor encotrou um erro inesperado que impede o processamento da solicitação. |
A API NÃO DEVE usar apenas 200 para sucesso ou 404 para erro. Cada mensagem de erro precisa ser personalizada e aplicar o código de retorno de acordo com a sua semântica.