Verificador de diferencias de contratos API

Examen privado multicontrato

Compara versiones de OpenAPI, AsyncAPI o GraphQL y explica cambios críticos localmente.

Formato del contrato

Contrato de referencia

El último contrato liberado o aceptado.

Contrato actual

El contrato candidato a revisar.

openapi: 3.1.0
info: { title: Pet API, version: 2.0.0 }
paths:
  /pets/{id}:
    get:
      summary: Get one pet
      security: [{ bearerAuth: [] }]
      parameters:
        - { name: id, in: path, required: true, schema: { type: integer } }
        - { name: locale, in: query, required: true, schema: { type: string } }
      responses:
        '200':
          description: Pet
          content: { application/json: { schema: { $ref: '#/components/schemas/Pet' } } }
  /pets:
    post:
      requestBody:
        required: true
        content: { application/json: { schema: { $ref: '#/components/schemas/PetInput' } } }
      responses: { '201': { description: Created } }
components:
  securitySchemes: { bearerAuth: { type: http, scheme: bearer } }
  schemas:
    Pet:
      type: object
      required: [id, name]
      properties: { id: { type: string }, name: { type: string }, status: { type: string, enum: [active, pending] } }
    PetInput:
      type: object
      required: [name]
      properties: { name: { type: string } }

Cómo usarla

01
Cargar ambos contratos
Pegar o abrir un contrato de base y actual OpenAPI, AsyncAPI o GraphQL.
02
Revisión de la compatibilidad
Inspeccione los cambios de operación, entrada, respuesta, seguridad y esquema con pruebas antes y después.
03
Planifique la liberación
Mark revisó las excepciones y exportó un registro de cambios, datos de auditoría o una decisión de CI.

Preguntas frecuentes

¿Se cargan los contratos API?

No. Análisis, normalización, comparación y exportación se ejecutan en este navegador.

¿Qué contratos se apoyan?

Se admiten OpenAPI 3.x, estructuras comunes de AsyncAPI 2 y 3, y GraphQL SDL.

¿Esto reemplaza las pruebas del contrato?

No. La comparación estática de contratos es una capa de revisión temprana; los validadores de tiempo de funcionamiento y las pruebas del consumidor siguen siendo necesarios.

¿Se obtienen referencias externas?

No. Las referencias a los componentes locales se resuelven cuando son compatibles; las referencias a distancia se comunican como límites de revisión.

Continúa con otras utilidades web específicas.

Todas las herramientas

Cómo usarla

Cargar ambos contratos

Revisión de la compatibilidad

Planifique la liberación

Preguntas frecuentes

Herramientas relacionadas

Editor de OpenAPI y Probador de Contratos

Explorador de Consultas y Esquemas GraphQL

Editor y Validador de AsyncAPI