SkillEngenhariaRevisao

API Design Reviewer

Revisa contratos de API quanto a consistencia, usabilidade, versionamento, erros, seguranca e breaking changes.

Ações
PerfilDev
ProfundidadeAlta
Idiomapt-BR
Objetivo

Em uma frase.

Identificar problemas de desenho de API antes que contratos ruins sejam implementados, publicados ou consumidos por clientes.

Aplicação

Quando
faz sentido.

Usar
  • Antes de implementar endpoints novos.
  • Ao revisar OpenAPI, rotas, controllers ou GraphQL schema.
  • Quando uma mudanca pode quebrar consumidores existentes.
  • Para padronizar erros, paginacao, filtros, autenticacao e nomenclatura.