API-Spec-Prüfer für OpenAPI
Lade deine OpenAPI-Beschreibung hoch und sieh, was daran nicht stimmt: jede Stelle mit ihrem Pfad im Dokument, dem Fehler und dem, was stattdessen gelesen wurde.
Kostenlos. Du brauchst nur ein Konto.
So sieht ein Ergebnis aus
Eine öffentliche API-Beschreibung, wie sie im Netz steht, einmal durch den Prüfer geschickt.
Was er meldet
Der Prüfer liest dein Dokument mit demselben Leser, der im Generator steckt. Worüber er stolpert, schreibt er auf — in drei Arten.
Fehler
Hier fehlt etwas oder es ist ungenau: ein Verweis, der ins Leere zeigt, ein Platzhalter im Pfad ohne Parameter.
Warnung
Hier bricht das Dokument eine Regel, lässt sich aber auf genau eine Weise lesen: ein Schlüssel an der falschen Stelle, ein Typ in falscher Schreibweise.
Hinweis
Hier ist das Dokument in Ordnung, lässt aber etwas offen, das ein Client für sich entscheiden muss.
So läuft eine Prüfung
Hochladen
Eine Datei, JSON oder YAML, bis 5 MB.
Lesen
Das Dokument wartet kurz in einer Warteschlange und wird dann in einem eigenen Prozess gelesen. Verweise auf fremde Adressen ruft er dabei nicht ab.
Ergebnis
Je Art bis zu 25 Stellen, der Rest als Zahl. Die Datei wird nach dem Lesen gelöscht, das Ergebnis nach 10 Minuten.
Was er nicht ist
Kein Urteil über das ganze Dokument. Er meldet, was beim Lesen auffällt — eine leere Liste heißt nicht, dass dein Dokument fehlerfrei ist. Was zu jeder Stelle steht, formuliert der Leser selbst, auf Englisch. Und sehr große Dokumente schafft er nicht in der Zeit, die eine Prüfung hat.