OpenAPI / Swagger Validator

Validiert OpenAPI 3.0/3.1- und Swagger 2.0-Dokumente strukturell: Pflichtfelder, Pfad-/Operationsvollständigkeit, Antwortcodes, $ref-Auflösung, operationId-Eindeutigkeit und Komponentenintegrität

Wichtige Fakten

Kategorie
Sicherheit & Validierung
Eingabetypen
textarea
Ausgabetyp
html
Sample-Abdeckung
4
API verfügbar
Yes

Überblick

Der OpenAPI / Swagger Validator überprüft Ihre API-Spezifikationen (OpenAPI 3.0/3.1 und Swagger 2.0) auf strukturelle Korrektheit. Das Tool analysiert Pflichtfelder, Pfad- und Operationsvollständigkeit, Antwortcodes, $ref-Referenzen sowie die Eindeutigkeit von operationIds, um fehlerfreie API-Dokumente zu gewährleisten.

Wann verwenden

  • •Vor dem Generieren von API-Clients oder Server-Stubs, um Syntax- und Strukturfehler in der Spezifikation auszuschließen.
  • •Bei der Integration von externen REST-APIs, um die Konformität der bereitgestellten Swagger- oder OpenAPI-Dateien zu prüfen.
  • •Während der API-Entwicklung, um sicherzustellen, dass alle Pfade, Antwortcodes und $ref-Komponenten korrekt verknüpft sind.

So funktioniert es

  • •Fügen Sie Ihr OpenAPI- (3.0/3.1) oder Swagger- (2.0) Dokument als YAML oder JSON in das Textfeld ein.
  • •Das Tool analysiert die Struktur, löst interne $ref-Referenzen auf und prüft Pflichtfelder sowie die Eindeutigkeit der operationIds.
  • •Eventuelle Fehler oder Warnungen bezüglich Pfaden, Antwortcodes oder Komponentenintegrität werden direkt im HTML-Bericht ausgegeben.

Anwendungsfälle

Überprüfung von OpenAPI-Dokumenten vor der automatischen Code-Generierung von SDKs.
Validierung von Swagger-Dateien von Drittanbietern vor der Integration in das eigene System.
Kontinuierliche Qualitätskontrolle von API-Definitionen während der Entwicklung.

Beispiele

1. Validierung einer unvollständigen OpenAPI 3.0 Spezifikation

API-Entwickler
Hintergrund
Ein Entwickler hat eine neue API-Spezifikation in YAML entworfen, erhält aber beim Generieren des Clients Fehlermeldungen.
Problem
Es ist unklar, welche Pfade oder Pflichtfelder in der OpenAPI-Datei fehlen oder fehlerhaft definiert sind.
Verwendung
Kopieren Sie den YAML-Code der API-Spezifikation in das Eingabefeld 'specInput' und starten Sie die Validierung.
Beispielkonfiguration
openapi: 3.0.3
info:
  title: Test API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
Ergebnis
Das Tool zeigt einen Fehler an, da für die GET-Methode unter '/users' keine Antwortcodes (responses) definiert wurden.

2. Fehlerhafte $ref-Referenzen in Swagger 2.0 aufspüren

Softwarearchitekt
Hintergrund
Bei der Migration einer alten API-Dokumentation im Swagger 2.0-Format treten Probleme mit den Datenmodellen auf.
Problem
Es gibt verwaiste oder falsch geschriebene Referenzen ($ref) im Definitions-Bereich der JSON-Datei.
Verwendung
Fügen Sie das Swagger 2.0 JSON-Dokument in das Textfeld ein, um die Komponentenintegrität zu prüfen.
Beispielkonfiguration
{
  "swagger": "2.0",
  "info": {
    "title": "Legacy API",
    "version": "1.0.0"
  },
  "paths": {
    "/items": {
      "get": {
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/NonExistentItem"
            }
          }
        }
      }
    }
  }
}
Ergebnis
Der Validator markiert die Referenz '#/definitions/NonExistentItem' als nicht auflösbar und listet den genauen Pfad des Fehlers auf.

Mit Samples testen

validation
OpenAPI/Swagger Beispiele
OpenAPI/Swagger Spezifikationsbeispiele für REST API-Dokumentation und Vertragsdefinition
title token openapi,swagger
sample
OpenAPI/Swagger Beispiele
Umfassende API-Dokumentationsbeispiele mit OpenAPI 3.0 und Swagger-Spezifikationen für RESTful-Services
title token openapi,swagger
sample
Mock Service Worker Beispiele
Umfassende MSW (Mock Service Worker) Beispiele mit API-Mocking, GraphQL, WebSocket-Mocking und fortgeschrittenen Request-Handling-Patterns
keywords api,rest
sample
Postman Collections - API Tests
Umfassende Postman Collection Beispiele inklusive API Tests, Automatisierungsskripte, Umgebungsvariablen, Mock Server und fortgeschrittene Testmuster für REST APIs
keywords api,rest
sample

Verwandte Hubs

Validierungs-Tools für Kennungen, Konfigurationen und Eingaben
Vergleichen Sie Validatoren für E-Mail, Telefon, IP, Datum, Cron, Barcodes, Zahlungsdaten, Env-Dateien und andere reale Eingaben in einem Hub.
Formatprufer fur Kennungen, Adressen und Codes
Gebundelte Werkzeuge fur Validierung von Kennungs-, Adress-, Konto- und Codeformaten in einem Hub.
Tools zur Validierung von Kontakt-, Post- und Versanddaten
Validieren Sie E-Mails, Telefonnummern, Postleitzahlen, internationale Vorwahlen und Sendungsnummern in einem Hub fuer Registrierungs-, Checkout- und Liefer-Workflows.
JSON-Schema- und API-Vertragsvalidierungs-Tools
Vergleichen Sie JSON-Schema-Validierung, OpenAPI-Response-Prüfung, Mutation Testing, Stress Testing und Breaking-Change-Erkennung in einem Hub für API-Vertragsreviews.

FAQ

Welche OpenAPI-Versionen werden unterstützt?

Das Tool unterstützt OpenAPI 3.0, OpenAPI 3.1 sowie das ältere Swagger 2.0-Format.

Können sowohl JSON- als auch YAML-Formate validiert werden?

Ja, Sie können Ihre API-Spezifikation sowohl im YAML- als auch im JSON-Format einfügen.

Was passiert, wenn eine $ref-Referenz fehlerhaft ist?

Der Validator erkennt nicht auflösbare $ref-Referenzen und listet diese als Fehler im Validierungsbericht auf.

Prüft das Tool auch die Eindeutigkeit von operationIds?

Ja, doppelt vergebene operationIds werden identifiziert und als Validierungsfehler markiert.

Werden meine API-Spezifikationen auf einem Server gespeichert?

Nein, die Validierung erfolgt direkt im Browser oder wird temporär verarbeitet, ohne Ihre API-Daten dauerhaft zu speichern.

API-Dokumentation

Request-Endpunkt

POST /de/api/tools/openapi-validator

Request-Parameter

Parameter-Name Typ Erforderlich Beschreibung
specInput textarea Ja -

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-openapi-validator": {
      "name": "openapi-validator",
      "description": "Validiert OpenAPI 3.0/3.1- und Swagger 2.0-Dokumente strukturell: Pflichtfelder, Pfad-/Operationsvollständigkeit, Antwortcodes, $ref-Auflösung, operationId-Eindeutigkeit und Komponentenintegrität",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=openapi-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]