OpenAPI Linter Online – Stilregeln für Spezifikationen

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

0 chars · 0 B

Teilen Sie dieses Tool:

OpenAPI Dokument

Probleme

Regelteilmenge im Spektralstil – kein vollständiges Spektral. Nur Pfadoperationen (keine Webhooks/Rückrufe).

Führen Sie Lint aus, um Probleme zu erkennen

Linting läuft in Ihrem Browser – es wird nichts hochgeladen.

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. • Status: bestanden / bestanden mit Warnungen / fehlgeschlagen. • Maximale Eingabe 512 KiB.

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"
  },
  „Pfade“: {
    "/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":"a@b.c"}},"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.

Weitere API- und Schema-Tools in diesem Cluster

Formatieren Sie OpenAPI OpenAPI validierenFlusen OpenAPIJSON Schema zu OpenAPI OpenAPI bis JSON Schema JSON Schema-Validator GraphQL validieren

Suchen Sie nach Konvertern, Encodern, Formatierern und Minifiern an einem Ort? Hub für Entwicklertools Öffnen Sie den kuratierten Entwicklertools-Katalog.