API - Guia de Estilo

Como documentar

282 views 13/04/2020 06/08/2020 andre-rezende 1

Para identificar as requisições HTTP e os payloads envolvidos, a documentação da API deverá estar disponibilizada no portal seguindo boas práticas.

  • Descrição e finalidade da API
  • Payload com tipo e descrição dos campos
  • Quais campos são obrigatórios
  • Valores de exemplo
  • Valores possíveis (geralmente quando há algum enum associado ao campo)
  • Campos numéricos inserir valores minimo e máximo quando necessário
  • Métodos HTTP suportados
  • Resposta possíveis (HTTP Code)
  • Headers necessários para fazer o request
  • Payload de resposta com tipo e descrição dos campos

Este artigo foi útil para você?