Boas Práticas
Utilizar e atender os códigos HTTPs corretamente
Para não fazer mau uso dos códigos de status, as respostas enviadas por nosso servidor devem ser bem contextualizadas e possuir esquemas consistentes.
Uma das boas práticas é buscar conhecer os fundamentos do protocolo HTTP. Os métodos presentes nesta documentação são: POST, GET, PATCH e DELETE.
POST – Para criação ou inserção de valores GET – Para recuperar dados do recurso específico PATCH – Para atualização parcial de algum dado / valor DELETE – Para exclusão de dados / valores
Atente-se também a utilizar os códigos HTTP corretamente. Pois através dele nossas APIs terão tratamentos exclusivos, como gerar novas tentativas de comunicação ou logs específicos.
Os códigos de status HTTP são mensagens do servidor informando como as coisas ocorreram após determinada requisição. Eles indicam para a aplicação requisitante a condição atual sobre o processamento da requisição feita.
Exemplos se sua API receber uma requisição da Frete Rápido:
- Se ocorrer tudo bem na sua aplicação, deve-se retornar status HTTP 200, ou 201, ou 202 (a depender da sua aplicação);
- Se ocorrer algum erro interno na sua aplicação, deve-se retornar status HTTP da família 500;
- Se ocorrer a falta de alguma informação ou requisição não autorizada, deve-se retornar status HTTP da família 400;
Confira a lista completa de códigos de status HTTP em: https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Status.