Skip to main content

MD33_JUNNY_API_DIFF_SYSTEM.md

API Diff System

Comparar contratos e respostas com visão added / modified / removed e sinais de breaking change, alinhado a CI e governança sem exigir motor enterprise na primeira entrega.

Stub backend

Fase: roadmap

Roadmap para diff visual de schemas/responses OpenAPI e GraphQL, detecção de breaking changes e relatórios exportáveis — local-first e integrável depois ao runner/contracts; sem realtime governance nem motor de approvals na v0.

ferramenta moderna de evolução APIs · evolução APIs com segurança · reduzir falhas produção

Tipos de diff

OpenAPI · GraphQL · Responses

Fluxo principal (alvo)

  1. selecionar schema A
  2. selecionar schema B
  3. executar compare
  4. visualizar diferenças

Visual diff · estados UX

Classes: added · removed · modified

Added — VerdeModified — AmareloRemoved — Vermelho

OpenAPI — compare

  • · endpoints
  • · request bodies
  • · response bodies
  • · status codes
  • · paths
  • · methods
  • · request schema
  • · response schema

GraphQL — compare

  • · types
  • · fields
  • · queries
  • · mutations
  • · enums

Response diff

payloads · status · headers

Breaking changes (sinais)

endpoint removidocampo removidotipo alteradoresponse incompatível

Backend planejado

/modules/diff
  comparators
  schemas
  reports

Componentes (planeados)

  • DiffViewer
  • SchemaComparator
  • BreakingChangesPanel
  • ResponseCompare

MVP alvo (MD33)

  • OpenAPI compare
  • GraphQL compare
  • response diff
  • breaking changes detection

Não iniciar neste roadmap

  • realtime governance
  • AI diff explanation
  • distributed compare
  • approval engine

UI futura em /features/diff