OpenAPI 3 / Swagger online validieren vor der CI
Schemafehler, defekte $ref, fehlende Responses: OpenAPI-3.0–3.2-Vertrag im Browser prüfen, vor der CI.
Eine OpenAPI-Spezifikation vor dem Merge validieren
Eine ungültige OpenAPI-Spezifikation blockiert Client-Generatoren, lässt API-Gateway-Importe scheitern und verzögert Vertragsprüfungen. Die häufigsten Fehler (unvollständiges info, defekte interne $ref, nicht unterstützte openapi-Version) verstecken sich oft in einem YAML-Diff mit 500 Zeilen. Der Online-OpenAPI-Validator von FastMinify prüft die Schema-Konformität für OpenAPI 3.0, 3.1 und 3.2 über @scalar/openapi-parser, vollständig im Browser. Fügen Sie JSON oder YAML ein, dann erscheinen Ergebnis, Fehlerpfade und Statistiken zur Spezifikation ohne Upload auf einen Server. Ergänzen Sie ihn mit dem OpenAPI-Formatter für lesbare Prüfungen und erkunden Sie den API-Tools-Hub. Bei fragwürdiger JSON-Syntax beginnen Sie mit dem JSON-Validator. Zur Optimierung der Payloads nach einem validierten Vertrag lesen Sie unseren REST-API-Performance-Leitfaden.
#/…-Referenzen geprüft, Fehlerpfade von Scalar angezeigtEhrliche Grenzen und Best Practices
Ein Ergebnis „gültig“ bedeutet Konformität mit dem OpenAPI-Schema, nicht dass Ihre API in Produktion korrekt antwortet.
$ref-URLsScalar prüft die #/-Referenzen. HTTP(S)-Referenzen auf andere Dateien werden nie aufgelöst, die Spezifikation muss daher für eine zuverlässige Validierung im Browser eigenständig sein.
$ref kann das Einlesen bestehen und trotzdem anderswo scheiternDas Browser-Werkzeug beschleunigt das Feedback vor dem Commit, die CI bleibt die maßgebliche Instanz für Teams.
git push ein, das ist schneller als eine volle PipelineWas das Werkzeug bei OpenAPI 3 und Swagger 2 prüft und ablehnt
OpenAPI 3.x beschreibt REST-Endpunkte, Request- und Response-Schemas, Sicherheit und wiederverwendbare Komponenten. FastMinify validiert die Konformität mit dem OpenAPI-Metaschema, nicht das Laufzeitverhalten Ihrer API.
3.0.x, 3.1.x, 3.2.xopenapi, info.title, info.version, pathsschemas, responses und parameters, mit aufgelösten internen ReferenzenDokumente mit dem Root-Key swagger: "2.0" werden von diesem Werkzeug nicht unterstützt. Die Fehlermeldung ist eindeutig, validieren Sie sie also nicht hier.
swagger; OpenAPI 3 nutzt openapiJenseits der Syntax bringen diese strukturellen Lücken die CI oder SDK-Generatoren zum Scheitern.
$ref auf eine fehlende Komponente führt zu einem Validierungsfehlerdescription verletzt eine OpenAPI-RegeloperationId blockiert manche Generatorentype, der mit schlecht verschachteltem nullable / oneOf nicht vereinbar istDer API-Hub bietet drei unterschiedliche Aufgaben: Verwechseln Sie sie bei der PR-Prüfung nicht.
Eine OpenAPI-Spezifikation Schritt für Schritt validieren
Der OpenAPI-Validator liest die Eingabe ein (JSON oder YAML, höchstens 512 KiB) und ruft dann validate() von Scalar auf. Das Ergebnis enthält einen Status, den ersten Fehler mit Zeile, wenn bekannt, und eine Problemliste mit JSON-Pointer-Pfaden.
https://…-Referenzen werden nie geladen, eine bewusste EinschränkungDer OpenAPI-Formatter schreibt JSON oder YAML mit 2 oder 4 Leerzeichen Einzug und optionaler Schlüsselsortierung neu. Er hilft bei der menschlichen Prüfung und ersetzt die Validierung nicht.
Sie exportieren eine Spezifikation aus einem Design-Werkzeug, und der Import in AWS API Gateway oder Kong scheitert ohne Details.
In validate-openapi einfügen
Öffnen Sie validate-openapi. Scheitert das Einlesen, korrigieren Sie zuerst die JSON- oder YAML-Syntax. Der JSON-Validator hilft bei den JSON-Anteilen.
Interne $ref korrigieren
Die Probleme von Scalar nennen den Pfad (etwa ein fehlendes #/components/schemas/User). Beheben Sie den Tippfehler oder ergänzen Sie die referenzierte Komponente.
Formatieren und einchecken
Schicken Sie die validierte Spezifikation durch format-openapi, laden Sie sie herunter und öffnen Sie die PR. Importieren Sie sie danach erneut ins Gateway.
Das Mobile-Team erzeugt einen Client aus der Spezifikation, und ein Schemafehler blockiert die gesamte Pipeline.
Die zusammengeführte Version validieren
Fügen Sie die Spezifikation des main-Branches in validate-openapi ein. Ein ungültiges Ergebnis heißt, dass Sie den Versions-Tag blockieren sollten.
info und paths prüfen
Die info-Felder müssen vollständig sein, und jede Operation braucht responses mit description. Die Statistiken im Ergebnispanel helfen, leere Pfade zu erkennen.
Eingebettete JSON-Beispiele minifizieren
Große eingebettete Beispiele verlangsamen Prüfungen: Nutzen Sie den JSON-Minifier für Beispiel-Payloads, sobald die Spezifikation gültig ist.
Zusammenfassung
Wer OpenAPI-Spezifikationen vor der CI validiert, spart Stunden bei der Fehlersuche in Gateway-Importen oder stillen SDK-Generatoren. Einfügen, validieren, die Scalar-Pfade korrigieren, alles lokal. Formatieren Sie für die Prüfung und erkunden Sie dann den API-Hub für Lint, JSON-Schema-Konvertierung und GraphQL-Validierung.
OpenAPI-Spezifikation jetzt validieren
Verwandte Artikel
Fügen Sie Token und JWKS ein und prüfen Sie eine RS256-, ES256- oder HS256-Signatur im Browser. Schlüsselwahl per kid, Fehler und zu prüfende Claims.
HTTP/2 und HTTP/3 ändern den Weg der Dateien, nicht ihre Größe. Messungen zu Größe, Kompilierzeit und Bundling zeigen, was Minifizierung noch bringt.
Rechnen Sie eine Unix-Epoche in ein lesbares Datum um und zurück, unterscheiden Sie Sekunden und Millisekunden und meiden Sie Zeitzonen-, JWT- und Zeitumstellungsfallen.