Leitfaden zur Tool-Nutzung

Erfahren Sie, wann dieses Tool passt, was es unterstützt und wie Nutzer es anwenden.

Wichtige Fakten

Kategorie: Validation
Eingabetypen: textarea
Ausgabetyp: html
Sample-Abdeckung: 4
API bereit: Ja

Ü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

1Fügen Sie Ihr OpenAPI- (3.0/3.1) oder Swagger- (2.0) Dokument als YAML oder JSON in das Textfeld ein.
2Das Tool analysiert die Struktur, löst interne $ref-Referenzen auf und prüft Pflichtfelder sowie die Eindeutigkeit der operationIds.
3Eventuelle 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.

Aufgabe

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.

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.

Aufgabe

Es gibt verwaiste oder falsch geschriebene Referenzen ($ref) im Definitions-Bereich der JSON-Datei.

Verwendung

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.

{
  "swagger": "2.0",
  "info": {
    "title": "Legacy API",
    "version": "1.0.0"
  },
  "paths": {
    "/items": {
      "get": {
        "responses": {
          "200": {
            "schema": {
              "$ref": "#/definitions/NonExistentItem"
            }
          }
        }
      }
    }
  }
}

OpenAPI / Swagger Validator

Dieses Tool ausführen

Beispiele zu diesem Tool

Mit verwandten Tools und Themen fortfahren

Erfahren Sie, wann dieses Tool passt, was es unterstützt und wie Nutzer es anwenden.

Wichtige Fakten

Überblick

Wann verwenden

So funktioniert es

Anwendungsfälle

Beispiele

1. Validierung einer unvollständigen OpenAPI 3.0 Spezifikation

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

FAQ

API-Versionierung und Pruefung von Breaking Changes

OpenAPI/Swagger Beispiele

OpenAPI/Swagger Beispiele

Android Java Bildverarbeitungsbeispiele

Android Kotlin Bildverarbeitungsbeispiele

Globaler Postleitzahlen-Validator

IBAN & SWIFT Validator

Mod-11-Prüfsummen-Rechner

US-Postleitzahlen-Validator