Padrão API

· Padrão API
Juan Kalleo
Juan Kalleo
Backend/API
This page hasn't been translated to English yet — showing the original Portuguese content.

Conteúdo em definição: esta área concentra os padrões de contrato HTTP, autenticação, paginação, erros, versionamento e segurança das APIs.

Visão geral

Esta seção será usada para registrar as decisões de API que impactam o front e os serviços consumidores: formato de resposta, envelope de erro, autenticação, autorização, auditoria e versionamento.

Contratos

  • Formato de resposta e envelope de erro.
  • Política de paginação, filtros e ordenação.
  • Headers de autenticação, autorização e auditoria.

Pendências

Substituir esta seção conforme os contratos reais forem consolidados.