Kategorien

← View All Tools

OpenAPI-Diff-Breaking-Change-Detektor

Vergleicht OpenAPI- oder GraphQL-Schemas, markiert Breaking Changes und erstellt einen impact-orientierten Bericht fuer API-Teams

Beispielergebnisse

2 Beispiele

Entferntes Antwortfeld vor dem Release erkennen

Vergleicht zwei OpenAPI-Versionen und markiert eine Eigenschaft, die aus der 200-Antwort verschwunden ist

{
  "releaseRisk": "high",
  "summary": {
    "breakingChanges": 1
  },
  "changes": [
    {
      "path": "GET /users/{id} -> response 200.email",
      "summary": "Response field removed"
    }
  ]
}
Eingabeparameter anzeigen
{ "oldSchema": "openapi: 3.0.0\npaths:\n /users/{id}:\n get:\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n email: { type: string }\n", "newSchema": "openapi: 3.0.0\npaths:\n /users/{id}:\n get:\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n", "schemaType": "openapi", "includeImpactAnalysis": true }

Aenderung eines GraphQL-Input-Vertrags pruefen

Erkennt neue Pflichtfelder in einem Input-Objekt, damit Frontend- und Mobile-Teams ihre Mutationen rechtzeitig anpassen koennen

{
  "schemaType": "graphql",
  "summary": {
    "totalChanges": 1,
    "breakingChanges": 1,
    "dangerousChanges": 0,
    "nonBreakingChanges": 0
  },
  "impactedAreas": [
    "field"
  ],
  "releaseRisk": "high",
  "changes": [
    {
      "severity": "breaking",
      "area": "field",
      "path": "input:CreatePostInput.category",
      "summary": "Required input field added",
      "impact": "Mutations or queries sending this input object must populate the new required field."
    }
  ]
}
Eingabeparameter anzeigen
{ "oldSchema": "input CreatePostInput { title: String! }\ntype Mutation { createPost(input: CreatePostInput!): String! }", "newSchema": "input CreatePostInput { title: String!, category: String! }\ntype Mutation { createPost(input: CreatePostInput!): String! }", "schemaType": "graphql", "includeImpactAnalysis": true }

Wichtige Fakten

Kategorie
Development
Eingabetypen
textarea, select, text, checkbox
Ausgabetyp
json
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der OpenAPI-Diff-Breaking-Change-Detektor vergleicht zwei Versionen von OpenAPI- oder GraphQL-Schemas und identifiziert automatisch Breaking Changes. Das Tool analysiert strukturelle Unterschiede, bewertet das Release-Risiko und generiert einen detaillierten Impact-Bericht, der API-Teams hilft, rückwärtsinkompatible Änderungen vor dem Deployment zu erkennen und Konsumenten frühzeitig zu informieren.

Wann verwenden

  • •Vor dem Deployment neuer API-Versionen, um rückwärtsinkompatible Änderungen zu identifizieren
  • •Beim Review von Pull Requests, die Schema-Änderungen enthalten
  • •Zur Kommunikation von API-Änderungen an Frontend- und Mobile-Teams

So funktioniert es

  • •Fügen Sie das vorherige Schema in das Feld 'Altes Schema' und die aktualisierte Version in 'Neues Schema' ein (YAML oder JSON für OpenAPI, SDL für GraphQL).
  • •Wählen Sie den Schema-Typ (OpenAPI/Swagger oder GraphQL) oder nutzen Sie die automatische Erkennung.
  • •Das Tool vergleicht die Strukturen, erkennt entfernte Felder, neue Pflichtfelder und Typänderungen.
  • •Sie erhalten einen JSON-Bericht mit Risikobewertung, Anzahl der Breaking Changes und betroffenen Bereichen.

Anwendungsfälle

Pre-Release-Validierung von API-Updates vor dem Produktiv-Deployment
Automatisierte Breaking-Change-Detection in CI/CD-Pipelines
Erstellung von Migrationsleitfäden für API-Konsumenten

Beispiele

1. Entferntes Antwortfeld vor dem Release erkennen

Hintergrund
Ein Backend-Team aktualisiert den User-Endpunkt und entfernt das Feld 'email' aus der 200-Antwort, ohne die Mobile-Clients zu informieren.
Problem
Das fehlende Feld würde bestehende Mobile-Apps zum Absturz bringen, die 'email' für die Benutzeranzeige erwarten.
Verwendung
Fügen Sie das alte OpenAPI-Schema in 'Altes Schema' und die aktualisierte Version in 'Neues Schema' ein. Aktivieren Sie die Impactanalyse, um das Risiko zu bewerten.
Ergebnis
Der Bericht markiert das entfernte Feld als Breaking Change mit hohem Risiko und zeigt den genauen Pfad 'GET /users/{id} -> response 200.email', sodass das Team die Änderung vor dem Deployment korrigieren kann.

2. Neues Pflichtfeld in GraphQL-Mutation identifizieren

Hintergrund
Das Schema-Team fügt dem CreatePostInput eine Kategorie hinzu, um Beiträge zu klassifizieren, und macht das Feld zur Pflichtangabe.
Problem
Alle bestehenden Mutations-Aufrufe ohne das neue 'category'-Feld schlagen fehl, was Frontend- und Mobile-Teams betrifft.
Verwendung
Geben Sie beide GraphQL-Schema-Versionen (SDL) in die Textfelder ein. Der Detektor erkennt automatisch oder durch manuelle Auswahl den GraphQL-Typ.
Ergebnis
Der JSON-Bericht klassifiziert die Änderung als Breaking Change im Bereich 'field' und warnt, dass alle Clients das neue Pflichtfeld in Mutations senden müssen.

Mit Samples testen

development
OpenAPI/Swagger Beispiele
Umfassende API-Dokumentationsbeispiele mit OpenAPI 3.0 und Swagger-Spezifikationen für RESTful-Services
title token openapi
sample
OpenAPI/Swagger Beispiele
OpenAPI/Swagger Spezifikationsbeispiele für REST API-Dokumentation und Vertragsdefinition
title token openapi
sample
Mock Service Worker Beispiele
Umfassende MSW (Mock Service Worker) Beispiele mit API-Mocking, GraphQL, WebSocket-Mocking und fortgeschrittenen Request-Handling-Patterns
keywords graphql,api
sample
Apache Pulsar Beispiele
Apache Pulsar Beispiele einschließlich Pub/Sub, Reader, Consumer mit verschiedenen Subscription-Typen, Schema-Management und Tiered Storage für Enterprise Messaging
keywords diff,schema
sample

Verwandte Hubs

Json-Generate-Tools
Entdecken Sie 33 json-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.
Design-Generate-Tools
Entdecken Sie 19 design-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.
Pdf-Generate-Tools
Entdecken Sie 10 pdf-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.
Audio-Generate-Tools
Entdecken Sie 8 audio-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.

FAQ

Was versteht das Tool unter einem Breaking Change?

Breaking Changes sind Schema-Änderungen, die bestehende Client-Integrationen zerstören, wie das Entfernen von Antwortfeldern, das Hinzufügen neuer Pflichtfelder in Inputs oder das Ändern von Feldtypen.

Welche Schema-Formate werden unterstützt?

OpenAPI 3.x und Swagger 2.0 in YAML oder JSON sowie GraphQL Schema Definition Language (SDL).

Wie funktioniert die automatische Schema-Erkennung?

Das Tool analysiert die Struktur der Eingabe, um anhand typischer Schlüsselwörter und Syntax zwischen OpenAPI- und GraphQL-Schemas zu unterscheiden.

Was enthält die Impactanalyse?

Die Analyse bewertet das Release-Risiko (hoch/mittel/niedrig), listet betroffene Pfade und Endpunkte auf und beschreibt die konkreten Auswirkungen auf API-Konsumenten.

Kann ich YAML mit JSON vergleichen?

Ja, das Tool normalisiert beide Formate intern, sodass Sie problemlos ein YAML-Schema mit einer JSON-Version vergleichen können.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/openapi-diff-breach-detector

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
oldSchema textarea Ja -
newSchema textarea Ja -
schemaType select Nein -
inputFormat text Nein -
includeImpactAnalysis checkbox Nein -

Antwortformat

{
  "key": {...},
  "metadata": {
    "key": "value"
  },
  "error": "Error message (optional)",
  "message": "Notification message (optional)"
}
JSON-Daten: JSON-Daten

MCP-Dokumentation

Fügen Sie dieses Tool zu Ihrer MCP-Server-Konfiguration hinzu: 

{
  "mcpServers": {
    "elysiatools-openapi-diff-breach-detector": {
      "name": "openapi-diff-breach-detector",
      "description": "Vergleicht OpenAPI- oder GraphQL-Schemas, markiert Breaking Changes und erstellt einen impact-orientierten Bericht fuer API-Teams",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=openapi-diff-breach-detector",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Sie können mehrere Tools verketten, z.B.: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, maximal 20 Tools.

Wenn Sie auf Probleme stoßen, kontaktieren Sie uns bitte bei [email protected]