OpenAPI Linter Online – Stilregeln für Spezifikationen

Lint OpenAPI 3.x-Stilregeln (Spectral-Stil-Teilmenge) – nur Pfadoperationen, 100 % im Browser.

Laden…
Lint OpenAPI Dokumentation
Wenden Sie eine Teilmenge im Spectral-Stil auf Pfadoperationen an.

Hinweise des Entwicklers

Benutzerdefinierte Teilmenge im Spectral-Stil – kein vollständiges Spectral OAS. Nur Vorgänge unter Pfaden (keine Webhooks/Callbacks in Version 1). Regeln: not-openapi, operation-operationId, operation-tags, info-contact, info-description, paths-kebab-case, operation-success-response, operation-description. Live-Debounced-Lint; Monaco-Eingabe mit JSON/YAML-Erkennung. Status: bestanden / bestanden mit Warnungen / fehlgeschlagen. Maximale Eingabe 512 KiB. Ergebnisbereich zeigt Regelzähler, Issue-Pfade und Spec-Statistiken.

Anwendungsfälle

Erzwingen Sie operationId, Tags und 2xx-Antworten bei Pfadoperationen. Erkennen Sie fehlende Informationen, Kontaktinformationen und Beschreibungen vor der Veröffentlichung. Bevorzugen Sie Dönerhüllen-Pfadsegmente (oder vN).

Beispiele

Warnungen wegen fehlender Operations-ID

Vor

{ "openapi": "3.1.0", "info": { "title": "Pets", "version": "1.0.0" }, "paths": { "/pets": { "get": { "operationId": "listPets", "tags": ["pets"], "summary": "List pets", "responses": { "200": { "description": "OK" } } } } } }

Nach

operation-operationId (Warnung), wenn operationId fehlt

Nur-Standard-Antworten schlagen fehl

Vor

{"openapi":"3.1.0","info":{"title":"t","version":"1","description":"d","contact":{"email":"[email protected]"}},"paths":{"/x":{"get":{"operationId":"x","tags":["t"],"summary":"s","responses":{"default":{"description":"e"}}}}}}

Nach

operation-success-response (Fehler) → fehlgeschlagen

Lint OpenAPI FAQ

Häufige Fragen

Ist das Full Spectral?

Nein. v1 enthält eine feste Teilmenge im Spectral-Stil, die in den Entwicklerhinweisen aufgeführt ist – keinen benutzerdefinierten Regelsatz-Runner.

Welche Vorgänge sind Linted?

Nur Pfadoperationen (get/put/post/delete/options/head/patch/trace). Webhooks und Rückrufe liegen in Version 1 außerhalb des Gültigkeitsbereichs.

Was bedeuten „Bestanden“ / „Bestanden mit Warnungen“ / „Nicht bestanden“?

fehlgeschlagen = irgendein Problem auf Fehlerebene; mit Warnungen übergeben = nur Warnungen; bestanden = keine Probleme. Wir zeigen niemals ein einfaches grünes „gültig“ an, wenn Warnungen vorliegen.

Validiert das Lint-Laufschema?

Nein. Für Lint sind openapi 3.x + Informationen und dann Stilregeln erforderlich. Verwenden Sie Validate OpenAPI für vollständige Schemakonformität.

API & Schemata

OpenAPI Tools zum Formatieren, Validieren und Flusen Ihrer Spezifikationen.

Weitere Werkzeugkategorien entdecken