Definir padrões de resposta nas APIs desenvolvidas em Javascript

Data: 19/04/22

Autores:

Igor Ramos de Oliveira (Assessor)

1. Objetivo

Definir padrões de retorno das APIs desenvolvidas em Javascript a fim de facilitar o consumo das mesmas sem a necessidade de ter que se adequar à estruturas diferentes.

2. Introdução

Os retornos das APIs, em geral, não segue um padrão pois não há um consenso sobre como esse retorno deve ser, isto porque a responsabilidade é de cada pessoa/equipe/empresa definir a forma que melhor lhe atende. A importância dessa definição se dá pelo fato de ter que se adequar apenas um vez. Assim, sempre que uma nova API for consumida, o consumidor já tem o conhecimento de como é a estrutura base da resposta.

3. Desenvolvimento

4. Conclusão

É possível concluir que um padrão de resposta é muito importante, e que com ele elimina a necessidade de retrabalho/readequação ao consumir uma nova API. O padrão proposto atende perfeitamente, até então, as mais diversas necessidades e portanto não há impedimentos para sua utilização.