Os códigos de status HTTP desempenham um papel crucial nas comunicações entre servidores e clientes, fornecendo informações sobre o resultado de uma solicitação. Contudo, algumas práticas podem levar a ambiguidades e dificultar a interpretação dos desenvolvedores. Neste artigo, exploraremos boas práticas para o uso de códigos de status HTTP, destacando a importância de mensagens claras e decisões que promovam uma experiência de usuário consistente.
Evite o Retorno de Status 200 com Mensagens de Erro:
Infelizmente é uma prática comum retornar um código de status 200 (OK) mesmo quando ocorre um erro, incluindo uma mensagem de erro no corpo da resposta.
Isso pode confundir clientes e tornar a detecção de erros menos intuitiva.
Em vez disso, utilize códigos de status apropriados para indicar o resultado real da solicitação, como 4xx para erros do cliente ou 5xx para erros do servidor.
Utilize Códigos de Status Específicos:
Escolher códigos de status específicos em vez de códigos genéricos ajuda na identificação precisa da natureza da resposta.
Por exemplo, ao invés de retornar um 4xx genérico para todas as falhas de autenticação, use o código 401 (Não Autorizado) para indicar claramente que a autenticação falhou.
Vamos ver a lista dos principais códigos HTTP e qual deveria ser seu uso:
- 2xx (Sucesso):
- 200 (OK): Solicitação bem-sucedida.
- 201 (Created): Recurso criado com sucesso.
- 204 (No Content): Solicitação bem-sucedida, sem retorno de conteúdo.
- 3xx (Redirecionamento):
- 301 (Moved Permanently): Recurso movido permanentemente.
- 302 (Found): Recurso temporariamente movido.
- 304 (Not Modified): Recurso não modificado desde a última solicitação.
- 4xx (Erro do Cliente):
- 400 (Bad Request): Solicitação inválida ou malformada.
- 401 (Unauthorized): Falha na autenticação.
- 403 (Forbidden): Acesso proibido ao recurso.
- 404 (Not Found): Recurso não encontrado.
- 5xx (Erro do Servidor):
- 500 (Internal Server Error): Erro interno no servidor.
- 502 (Bad Gateway): Gateway inválido.
- 503 (Service Unavailable): Serviço temporariamente indisponível.
Caso queira conferir a lista completa com todos os códigos http, clique aqui.
Exemplo de Boa Prática:
Suponha que você esteja desenvolvendo uma API e um cliente solicita uma entidade que não existe. Em vez de retornar um 200 (OK) com uma mensagem de erro no corpo, o que pode confundir o cliente, utilize um 404 (Not Found) para indicar claramente que o recurso não foi encontrado.
HTTP/1.1 404 Not Found
Content-Type: application/json
{
"error": {
"code": 404,
"message": "Recurso não encontrado"
}
}
Essa abordagem fornece uma resposta clara e concisa, indicando não apenas o status de erro, mas também uma mensagem descritiva que auxilia na compreensão do problema.
Mensagens Descritivas:
Inclua mensagens descritivas no corpo da resposta para fornecer detalhes adicionais.
Isso é particularmente útil durante o desenvolvimento e para usuários finais em casos de erro.
Certifique-se de não vazar informações sensíveis e mantenha as mensagens claras e concisas.
Redirecionamentos Adequados:
Ao implementar redirecionamentos, escolha os códigos de status apropriados, como 301 para redirecionamento permanente e 302 para redirecionamento temporário.
Isso ajuda os navegadores e outros clientes a entenderem como devem lidar com a nova localização.
Conclusão:
Adotar boas práticas com códigos de status HTTP é crucial para garantir comunicações eficazes entre servidores e clientes.
Ao seguir essas diretrizes, você promove uma experiência mais transparente para desenvolvedores e usuários finais, facilitando a detecção e resolução de problemas.
Mantenha a consistência em suas respostas HTTP para criar sistemas mais robustos e confiáveis.
Quer mais dicas de boas práticas sobre programação? Confira os outros posts do blog.
