Development

OpenAPI-Diff-Breaking-Change-Detektor

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

json· JSON-ErgebnisWerkzeug öffnen

Schnellstart

Rufen Sie dieses Werkzeug aus Ihrem Code in drei Sprachen auf.

cURL

curl -X POST 'https://api.elysiatools.com/de/api/tools/openapi-diff-breach-detector' \
  -H 'Content-Type: application/json' \
  -d '{"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","inputFormat":"auto","includeImpactAnalysis":true}'

API-Referenz

Senden Sie eine POST-Anfrage mit Ihren Eingaben als JSON. Dateiparameter erfordern einen vorherigen Upload.

Endpunkt

HTTP

POST https://api.elysiatools.com/de/api/tools/openapi-diff-breach-detector

Parameter

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

Antwortformat

JSON-Ergebnis

JSON

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

MCP-Integration

Fügen Sie dieses Werkzeug Ihrem Model-Context-Protocol-Server hinzu, damit KI-Agenten es auflisten und aufrufen können.

Serverkonfiguration

Fügen Sie diesen Block Ihrer MCP-Client-Konfiguration hinzu:

mcp.json

{
  "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://api.elysiatools.com/mcp/sse?toolId=openapi-diff-breach-detector",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Verfügbare Werkzeuge auflisten

Nach dem Verbinden mit dem SSE-Endpunkt listen Sie die bereitgestellten Werkzeuge auf:

tools/list

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/list"
}

Dieses Werkzeug aufrufen

Rufen Sie das Werkzeug über seine ID auf; Argumente werden aus seiner Parameterliste gebildet:

tools/call

{
  "jsonrpc": "2.0",
  "id": 2,
  "method": "tools/call",
  "params": {
    "name": "openapi-diff-breach-detector",
    "arguments": {
  "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",
  "inputFormat": "auto",
  "includeImpactAnalysis": true
}
  }
}

Verketten Sie mehrere Werkzeuge in einer Sitzung mit einer kommagetrennten toolId-Liste, z. B. /mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp (max. 20).

Fragen oder Probleme? Kontakt: [email protected]