API-Response-Contract-Validator

Validiert eine echte API-Antwort gegen das in OpenAPI 3.x deklarierte Response-Schema

Fuegen Sie ein OpenAPI-3.x-Dokument und eine echte API-Antwort ein und geben Sie dann Pfad, Methode und Statuscode an. Das Tool loest das passende Response-Schema auf und markiert fehlende Felder, Typfehler, Enum-Verstoesse und undokumentierte Felder.

So wird es genutzt:

  • OpenAPI-Spezifikation: YAML oder JSON einfuegen
  • Antwort-JSON: echte Runtime-Antwort einfuegen
  • Pfad / Methode / Statuscode: Operation und Antwortzweig angeben
  • Spec-Format: bei Unsicherheit auto lassen
  • Zusaetzliche Felder verbieten: warnt bei nicht dokumentierten Feldern

Beispielergebnisse

1 Beispiele

Pruefen, ob eine echte Antwort noch zum User-Schema passt

Validiert eine echte JSON-Antwort gegen OpenAPI und erkennt fehlende oder falsche Felder.

Contract validation issues
Eingabeparameter anzeigen
{ "openApiSpec": "openapi: 3.0.3\npaths:\n /users/{id}:\n get:\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n required: [id, name]\n properties:\n id: { type: integer }\n name: { type: string }\n active: { type: boolean }", "responseJson": "{\"id\":\"1\",\"active\":\"yes\"}", "path": "/users/42", "method": "get", "statusCode": "200", "specFormat": "yaml", "disallowAdditionalProperties": true }

Wichtige Fakten

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

Überblick

Der API-Response-Contract-Validator ist ein präzises Werkzeug für Entwickler und Tester, um echte API-Antworten gegen OpenAPI 3.x-Spezifikationen zu prüfen. Durch den direkten Abgleich von Laufzeit-JSON-Daten mit dem definierten Response-Schema deckt das Tool sofort fehlende Pflichtfelder, Datentypfehler, Enum-Verstöße und undokumentierte Eigenschaften auf. So stellen Sie sicher, dass Ihre API-Endpunkte exakt den vereinbarten Vertrag einhalten und Integrationsprobleme frühzeitig vermieden werden.

Wann verwenden

  • •Wenn Sie nach Backend-Änderungen sicherstellen müssen, dass die tatsächlichen JSON-Antworten noch der dokumentierten OpenAPI-Spezifikation entsprechen.
  • •Bei der Fehlersuche in Frontend-Anwendungen, um zu prüfen, ob die API unerwartete Datenstrukturen oder falsche Datentypen liefert.
  • •Während der Entwicklung von Consumer-Driven Contracts, um Mock-Daten oder Staging-Antworten gegen das offizielle Schema zu validieren.

So funktioniert es

  • •Fügen Sie Ihre OpenAPI 3.x-Spezifikation im YAML- oder JSON-Format in das erste Textfeld ein.
  • •Kopieren Sie die tatsächliche JSON-Antwort Ihrer API in das Feld 'Antwort-JSON'.
  • •Geben Sie den genauen Pfad, die HTTP-Methode und den Statuscode an, um das korrekte Schema in der Spezifikation zu lokalisieren.
  • •Aktivieren Sie bei Bedarf 'Zusätzliche Felder verbieten', um Warnungen für nicht dokumentierte Eigenschaften zu erhalten, und starten Sie die Validierung.

Anwendungsfälle

Automatisierte Überprüfung von Staging-APIs vor einem Produktions-Release auf Schema-Konformität.
Identifikation von fehlerhaften Datentypen (z. B. String statt Integer) in Legacy-Backend-Systemen.
Validierung von Webhook-Payloads oder Drittanbieter-APIs gegen deren offizielle Dokumentation.

Beispiele

1. Prüfung einer fehlerhaften Benutzer-API-Antwort

Backend-Entwickler
Hintergrund
Ein Frontend-Team meldet Abstürze, weil die API unerwartete Datentypen zurückgibt.
Problem
Es muss schnell geprüft werden, ob die echte API-Antwort vom dokumentierten Schema abweicht.
Verwendung
Fügen Sie die OpenAPI-Spezifikation und die fehlerhafte JSON-Antwort ein. Setzen Sie den Pfad auf '/users/42', die Methode auf 'GET' und den Statuscode auf '200'.
Beispielkonfiguration
{"path": "/users/42", "method": "get", "statusCode": "200", "disallowAdditionalProperties": true}
Ergebnis
Das Tool markiert das Feld 'id' als Fehler (String statt Integer) und warnt vor einem undokumentierten Feld 'active'.

2. Validierung eines POST-Requests mit strikten Regeln

QA-Ingenieur
Hintergrund
Bei der Erstellung neuer Datensätze darf die API keine internen Datenbankfelder in der Antwort leaken.
Problem
Sicherstellen, dass die API-Antwort nach einem POST-Request exakt dem Vertrag entspricht und keine überflüssigen Felder enthält.
Verwendung
Fügen Sie die Spezifikation und die POST-Antwort ein. Wählen Sie die Methode 'POST', den Statuscode '201' und aktivieren Sie 'Zusätzliche Felder verbieten'.
Ergebnis
Die Validierung schlägt fehl und hebt das geleakte Feld 'internal_db_id' hervor, da es nicht im OpenAPI-Schema definiert ist.

Mit Samples testen

json
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
json
AWS EventBridge Beispiele
AWS EventBridge Beispiele einschließlich Event Buses, Rules, Targets, Schema Registry, Custom Events und Cross-Account Event Routing für Serverless Event-Driven Architecture
preferred input family json
json
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
preferred input family json
json
OpenAPI/Swagger Beispiele
Umfassende API-Dokumentationsbeispiele mit OpenAPI 3.0 und Swagger-Spezifikationen für RESTful-Services
preferred input family json
json

Verwandte Hubs

Json-Validate-Tools
Entdecken Sie 7 json-Tools für validate-Workflows und vergleichen Sie ähnliche Utilities schnell.
Json-Convert-Tools
Entdecken Sie 100 json-Tools für convert-Workflows und vergleichen Sie ähnliche Utilities schnell.
Json-Tools
Entdecken Sie 45 json-Tools für utility-Workflows und vergleichen Sie ähnliche Utilities schnell.
Json-Generate-Tools
Entdecken Sie 33 json-Tools für generate-Workflows und vergleichen Sie ähnliche Utilities schnell.

FAQ

Welche OpenAPI-Versionen werden unterstützt?

Das Tool unterstützt OpenAPI 3.x-Spezifikationen. Sie können diese sowohl im YAML- als auch im JSON-Format einfügen.

Was passiert, wenn meine API-Antwort zusätzliche Felder enthält?

Standardmäßig werden zusätzliche Felder ignoriert. Wenn Sie jedoch die Option 'Zusätzliche Felder verbieten' aktivieren, markiert das Tool diese als Fehler.

Muss ich die gesamte OpenAPI-Spezifikation einfügen?

Ja, die Spezifikation sollte vollständig genug sein, um den angegebenen Pfad, die Methode und alle referenzierten Schemata (z. B. über $ref) korrekt aufzulösen.

Werden Datentypen strikt validiert?

Ja, das Tool prüft präzise, ob Strings, Integer, Booleans und Arrays exakt den im Schema definierten Typen entsprechen.

Wie gebe ich Pfadparameter an?

Sie können den tatsächlichen Pfad wie '/users/42' eingeben. Das Tool gleicht ihn automatisch mit dem Vorlagenpfad (z. B. '/users/{id}') in der Spezifikation ab.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/api-response-contract-validator

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
openApiSpec textarea Ja -
responseJson textarea Ja -
path text Ja -
method select Nein -
statusCode text Ja -
specFormat select Nein -
disallowAdditionalProperties checkbox 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-response-contract-validator": {
      "name": "api-response-contract-validator",
      "description": "Validiert eine echte API-Antwort gegen das in OpenAPI 3.x deklarierte Response-Schema",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-response-contract-validator",
      "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]