API Breaking-Changes-Detektor und Migrationsplaner

Vergleicht zwei OpenAPI-3.x-Schemas, erkennt Breaking Changes und liefert Migrationshinweise

Hilft API-Teams vor Releases bei der Bewertung von Feldentfernungen, Typveraenderungen und neuen Pflichtfeldern.

Beispielergebnisse

1 Beispiele

Breaking Changes zwischen API-Versionen erkennen

Vergleicht zwei OpenAPI-Schemas und findet Aenderungen mit Client-Breaking-Risiko

Breaking changes are grouped by impact with migration strategies.
Eingabeparameter anzeigen
{ "oldSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: false\n content:\n application/json:\n schema:\n type: object\n properties:\n name: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n name: { type: string }\n", "newSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: true\n content:\n application/json:\n schema:\n type: object\n required: [name, role]\n properties:\n name: { type: string }\n role: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n" }

Wichtige Fakten

Kategorie
Entwicklung & Web
Eingabetypen
textarea
Ausgabetyp
html
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der API Breaking-Changes-Detektor und Migrationsplaner ist ein unverzichtbares Werkzeug für Entwicklerteams, um zwei OpenAPI-3.x-Schemas miteinander zu vergleichen. Das Tool analysiert die Unterschiede zwischen einer alten und einer neuen API-Version, identifiziert kritische Änderungen wie entfernte Felder, geänderte Datentypen oder neue Pflichtparameter und erstellt einen übersichtlichen HTML-Bericht. So lassen sich Integrationsprobleme bei Clients bereits vor dem Release zuverlässig erkennen und durch konkrete Migrationshinweise beheben.

Wann verwenden

  • •Vor dem Release einer neuen API-Version, um unbeabsichtigte Breaking Changes zu identifizieren.
  • •Beim Review von Pull Requests, die Änderungen an der OpenAPI-Spezifikation enthalten.
  • •Bei der Planung von Client-Migrationen, um den Anpassungsaufwand für Frontend- oder Mobile-Teams abzuschätzen.

So funktioniert es

  • •Fügen Sie das bisherige OpenAPI-3.x-Schema in das Textfeld 'Altes OpenAPI-Schema' ein.
  • •Kopieren Sie die aktualisierte Spezifikation in das Feld 'Neues OpenAPI-Schema'.
  • •Starten Sie den Vergleich, um die Analyse der Struktur- und Typänderungen durchzuführen.
  • •Prüfen Sie den generierten HTML-Bericht, der alle Breaking Changes nach Kritikalität gruppiert und Lösungsansätze bietet.

Anwendungsfälle

Sicherstellung der Abwärtskompatibilität bei der Weiterentwicklung von Microservices.
Erstellung von Changelogs und Migrationsleitfäden für externe API-Konsumenten.
Automatisierte Qualitätssicherung von API-Design-Richtlinien innerhalb von Entwicklerteams.

Beispiele

1. Erkennung von neuen Pflichtfeldern

Backend-Entwickler
Hintergrund
Das Team hat den `/users`-Endpunkt überarbeitet und dabei die Rolle des Nutzers als Pflichtfeld hinzugefügt sowie die ID aus der Antwort entfernt.
Problem
Es muss geprüft werden, ob diese Änderungen bestehende Clients beeinträchtigen und wie hoch das Risiko ist.
Verwendung
Fügen Sie die alte Spezifikation (ohne Pflichtfeld) und die neue Spezifikation (mit `required: [name, role]`) in die jeweiligen Textfelder ein.
Beispielkonfiguration
Altes Schema: requestBody required: false
Neues Schema: requestBody required: true, properties: [name, role]
Ergebnis
Das Tool generiert einen HTML-Bericht, der das neue Pflichtfeld 'role' und das entfernte Response-Feld 'id' als kritische Breaking Changes markiert und Migrationsschritte vorschlägt.

2. Analyse von Datentyp-Änderungen

API-Architekt
Hintergrund
Ein bestehendes Feld für eine Telefonnummer wurde in der neuen API-Version von 'string' auf 'integer' geändert, um die Validierung zu verbessern.
Problem
Die Auswirkungen dieser Typänderung auf bestehende Integrationen müssen vor dem Deployment bewertet werden.
Verwendung
Geben Sie das alte Schema mit 'type: string' und das neue Schema mit 'type: integer' in den Detektor ein.
Ergebnis
Der Bericht weist die Typänderung als Breaking Change aus, da Clients, die weiterhin Strings senden, nun Validierungsfehler erhalten würden.

Mit Samples testen

development
Postman Collections - API Tests
Umfassende Postman Collection Beispiele inklusive API Tests, Automatisierungsskripte, Umgebungsvariablen, Mock Server und fortgeschrittene Testmuster für REST APIs
title token api
sample
OpenAI API Beispiele
Umfassende OpenAI API Beispiele einschließlich GPT-Modelle, DALL-E Bildgenerierung, Whisper Audioverarbeitung und Funktionsaufrufe
title token api
sample
WebGPU Grafik-API
Moderne Grafik-API für hochperformante 3D-Grafik und GPU-Computing im Browser
title token api
sample
Truffle Development Suite Beispiele
Truffle Ethereum-Entwicklungsframework-Beispiele einschließlich Smart Contracts, Tests, Deployment, Migrations, Debugging und Entwicklungs-Workflows
keywords migration,contract,testing
sample

FAQ

Welche OpenAPI-Versionen werden unterstützt?

Das Tool ist für den Vergleich von OpenAPI-3.x-Schemas (z. B. 3.0.3) optimiert.

Was gilt als Breaking Change?

Dazu gehören unter anderem das Entfernen von Endpunkten oder Response-Feldern, das Hinzufügen neuer Pflichtfelder im Request sowie striktere Datentypen.

Werden meine API-Schemas gespeichert?

Nein, die Verarbeitung erfolgt direkt und die eingegebenen Schemas werden nicht dauerhaft auf unseren Servern gespeichert.

Kann ich das Tool auch für Swagger 2.0 nutzen?

Das Tool ist primär auf die Struktur von OpenAPI 3.x ausgelegt. Swagger 2.0-Dateien sollten vor dem Vergleich auf OpenAPI 3.x aktualisiert werden.

Wie hilft mir der Migrationsplaner?

Der generierte HTML-Bericht listet nicht nur die inkompatiblen Änderungen auf, sondern liefert auch konkrete Strategien, wie Clients auf die neue API-Struktur migriert werden können.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/api-breaking-changes-detector-migration-planner

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
oldSchema textarea Nein -
newSchema textarea Nein -

Antwortformat

{
  "result": "
Processed HTML content
",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
HTML: HTML

MCP-Dokumentation

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

{
  "mcpServers": {
    "elysiatools-api-breaking-changes-detector-migration-planner": {
      "name": "api-breaking-changes-detector-migration-planner",
      "description": "Vergleicht zwei OpenAPI-3.x-Schemas, erkennt Breaking Changes und liefert Migrationshinweise",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-breaking-changes-detector-migration-planner",
      "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]