Ainda não tem acesso? Estude com a gente! Matricule-se
Ainda não tem acesso? Estude com a gente! Matricule-se

Padrão de respostas API rest

Boa tarde,

Gostaria de saber se existe alguma padrão nas respostas de uma API tanto pra sucesso quanto pra erro, algo como um modelo da estrutura do json que devo retornar pra quem vai consumir a api.

1 resposta

Boa noite, Jailson! Como vai?

Excelente pergunta! Existe sim! Cada operação feita pela API deve utilizar os métodos HTTP corretos e devolver o status e, se necessário, uma mensagem no corpo da resposta seguindo o que foi estabelecido no protocolo HTTP.

Sendo assim, recomendo vc dar uma olhada na documentação dos métodos HTTP e ver como eles são utilizados dependendo do tipo de operação que vc está fazendo na API.

Para saber mais:

Um bom ponto de partida são esses dois links.

https://developer.mozilla.org/pt-BR/docs/Web/HTTP/Methods

https://tools.ietf.org/html/rfc7231#section-4

Pegou a ideia? Qualquer coisa é só falar!

Grande abraço e bons estudos, meu aluno!