API-Vertrags-Diff-Prüfer

Überprüfung privater Mehrauftragsverträge

Vergleiche OpenAPI, AsyncAPI oder GraphQL‑Versionen und erkläre lokale Breaking‑Changes.

Vertragsformat

Ausgangsvertrag

Der zuletzt freigegebene oder angenommene Vertrag.

Laufender Vertrag

Der Bewerbervertrag zur Überprüfung.

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 } }

So funktioniert es

01
Beide Verträge laden
Einfügen oder öffnen Sie einen Basisvertrag mit OpenAPI, AsyncAPI oder GraphQL.
02
Überprüfen Sie die Kompatibilität
Kontrollieren Sie Betrieb, Eingabe, Antwort, Sicherheit und Schema Änderungen mit vor und nach Beweisen.
03
Planen Sie die Freigabe
Mark überprüfte Ausnahmen und Export eines Changelogs, Audit-Daten oder CI-Entscheidung.

Häufig gestellte Fragen

Werden API-Kontrakte hochgeladen?

Nein. Parsing, Normalisierung, Vergleich und Export laufen in diesem Browser.

Welche Verträge werden unterstützt?

OpenAPI 3.x, gemeinsame AsyncAPI 2 und 3 Strukturen und GraphQL SDL werden unterstützt.

Ersetzt dies Vertragstests?

Nein. Statischer Vertragsvergleich ist eine frühe Überprüfungsschicht; Laufzeitvalidatoren und Verbrauchertests bleiben notwendig.

Werden externe Referenzen abgerufen?

Nein. Lokale Komponentenreferenzen werden dort aufgelöst, wo unterstützt wird; Remote-Referenzen werden als Überprüfungsgrenze gemeldet.

Arbeiten Sie mit weiteren fokussierten Browser-Hilfsmitteln weiter.

Alle Tools

So funktioniert es

Beide Verträge laden

Überprüfen Sie die Kompatibilität

Planen Sie die Freigabe

Häufig gestellte Fragen

Ähnliche Tools

OpenAPI-Editor & Vertrags-Tester

GraphQL-Abfrage & Schema-Explorer

AsyncAPI-Editor & -Validator