API - Guia de Estilo

Retorno de sucesso e erros

191 views 05/08/2020 06/08/2020 jefersonfrancisco 0

CÓDIGOS DE RETORNO PADRÃO

Os códigos são padronizados no protocolo HTTP e diversas ferramentas e frameworks possuem mecanismos para lidar com estes códigos padronizados. A seguir é listado os principais códigos utilizados na plataforma.

 

HTTP Code Título Descrição
200 OK Ação realizada com SUCESSO
201 CREATED Ação realizada com SUCESSO e um novo recurso foi CRIADO
400 BAD REQUEST Os dados enviados para o serviço estão inválidos ou incompletos, por exemplo, quando o JSON não é um conteúdo válido ou quando um campo obrigatório não foi informado.
401 UNAUTHORIZED O consumidor não está AUTENTICADO ou as credenciais informadas expiraram.
403 FORBIDDEN O consumidor não está AUTORIZADO a utilizar este serviço. Por exemplo, não possui permissão a um determinado recurso.
404 NOT_FOUND Não encontrou o recurso solicitado, por exemplo, não encontrou uma entidade pelo ID informado.
409 CONFLICT O recurso que está tentando criar já existe ou ainda o recurso que está tentando atualizar já está diferente do estado original (eTag).
500 INTERNAL SERVER ERROR Quando ocorre uma Exception genérica ou não tratada. Normalmente não deveria ocorrer este tipo de código de erro.

 

 

Este artigo foi útil para você?