Was ist ein OpenAPI-/Swagger-Formatter?

Es ist ein Tool, das eine OpenAPI-3.x- oder Swagger-2.0-API-Spezifikation parst und sie als sauberes, konsistent eingerücktes JSON oder YAML ausgibt, während es die Version und die Anzahl der Pfade und Operationen meldet, sodass Sie eine Spec schnell prüfen und standardisieren können.

Unterstützt es sowohl JSON- als auch YAML-Specs?

Ja. Da JSON selbst gültiges YAML ist, können Sie jedes Format einfügen. Verwenden Sie den JSON-/YAML-Schalter, um zu wählen, wie die formatierte Ausgabe ausgegeben wird, was es Ihnen auch erlaubt, eine Spec von einem Format in das andere zu konvertieren.

Validiert es meine Spec vollständig gegen das OpenAPI-Schema?

Es validiert, dass das Dokument als wohlgeformtes JSON oder YAML parst, und erkennt Version, Titel, Pfade und Operationen. Es führt keine vollständige JSON-Schema-Validierung jedes Felds durch, sodass es eine fehlende erforderliche Eigenschaft tief in einer Operation nicht kennzeichnet.

Welche Versionen erkennt es?

Es kennzeichnet OpenAPI 3.x über das openapi-Feld und Swagger 2.0 über das swagger-Feld. Jedes Dokument ohne eines dieser Felder wird formatiert, aber als unbekannte Version markiert.

Wird meine API-Spec irgendwohin hochgeladen?

Nein. Parsen, Validierung und Formatierung laufen vollständig in Ihrem Browser. Die eingefügte Spec verlässt niemals Ihr Gerät, und nichts wird zu ArrayKit hochgeladen, sodass interne oder unveröffentlichte API-Verträge privat bleiben.

Kann ich das formatierte Ergebnis herunterladen?

Ja. Die formatierte Spec kann je nach gewähltem Ausgabeformat kopiert oder als openapi.json oder openapi.yaml heruntergeladen werden.

OpenAPI / Swagger Formatter

Format and validate OpenAPI / Swagger specs (JSON or YAML) and count paths and operations.

Dies ist ein lokales Tool: Es läuft vollständig in Ihrem Browser. Die eingefügte OpenAPI- oder Swagger-Spec verlässt niemals Ihr Gerät — nichts wird zu ArrayKit oder einem Server hochgeladen.

Zwischen YAML und JSON konvertieren

Über OpenAPI / Swagger Formatter

Der ArrayKit-OpenAPI-Formatter verschönert und validiert OpenAPI- und Swagger-Spezifikationen in JSON oder YAML, alles in Ihrem Browser. Fügen Sie eine Spec ein, und er parst das Dokument, meldet die erkannte Version (OpenAPI 3.x oder Swagger 2.0), den API-Titel und zählt, wie viele Pfade und Operationen sie definiert, und gibt dann sauberes, konsistent eingerücktes JSON oder YAML aus. Es ist für Backend- und API-Entwickler, technische Redakteure und Plattform-Teams gedacht, die schnell einen handbearbeiteten Vertrag aufräumen, zwischen JSON und YAML konvertieren oder eine Spec plausibilisieren müssen, bevor sie committet oder an Swagger UI, Codegeneratoren oder ein Gateway übergeben wird. Da die Anfrageerstellung und das Parsen lokal geschehen, können Sie interne oder unveröffentlichte API-Definitionen formatieren, ohne sie an einen Server zu senden. Verwenden Sie es, um fehlerhaftes YAML zu erkennen, Operationsanzahlen zu bestätigen und die Formatierung über ein Repo hinweg zu standardisieren.

Funktionen

Akzeptiert sowohl JSON- als auch YAML-Eingabe — JSON ist gültiges YAML, also parst beides
Erkennt und kennzeichnet die Spec-Version: OpenAPI 3.x oder Swagger 2.0
Meldet den API-Titel plus eine Live-Zählung der Pfade und Operationen
Zählt die acht HTTP-Operationen (get, put, post, delete, options, head, patch, trace)
Schalten Sie die Ausgabe zwischen schön formatiertem JSON und YAML mit 2 Leerzeichen um
Zeigt Parse-Fehler mit der zugrunde liegenden Meldung an, wenn ein Dokument fehlerhaft ist
Warnt, wenn kein openapi- oder swagger-Feld vorhanden ist, sodass unbekannte Specs auffallen
Laden Sie das formatierte Ergebnis als openapi.json oder openapi.yaml herunter

So verwendest du OpenAPI / Swagger Formatter

Fügen Sie Ihre OpenAPI- oder Swagger-Spec (JSON oder YAML) in das Eingabefeld ein
Wählen Sie das Ausgabeformat mit dem JSON-/YAML-Schalter in der Symbolleiste
Lesen Sie das Zusammenfassungs-Banner für Version, Titel, Pfadanzahl und Operationsanzahl
Kopieren Sie die formatierte Spec oder laden Sie sie als openapi.json oder openapi.yaml herunter

Beispiel

Eingabe

openapi: 3.0.3
info: { title: Example API, version: 1.0.0 }
paths:
  /users:
    get: { summary: List users, responses: { '200': { description: OK } } }
    post: { summary: Create user, responses: { '201': { description: Created } } }

Ausgabe

openapi: 3.0.3
info:
  title: Example API
  version: 1.0.0
paths:
  /users:
    get:
      summary: List users
      responses:
        '200':
          description: OK
    post:
      summary: Create user
      responses:
        '201':
          description: Created

Eine minimale OpenAPI-3.0-Spec — der Formatter meldet 'OpenAPI 3.0.3 · Example API · 1 path · 2 operations'.

Häufige Fehler & Fehlerbehebung

Die Zusammenfassung zeigt 'Unknown — no openapi/swagger field'. — Fügen Sie ein openapi: 3.x.x (oder swagger: '2.0') auf oberster Ebene hinzu; ohne dieses Feld kann die Version nicht erkannt werden, obwohl das Dokument dennoch formatiert wird.
Ein YAML-Parse-Fehler erscheint, oft zu falscher Einrückung oder einem Tabulatorzeichen. — YAML ist einrückungssensitiv und verbietet Tabulatoren — ersetzen Sie Tabulatoren durch Leerzeichen und richten Sie Schlüssel konsistent aus, dann fügen Sie erneut ein.
Die Operationsanzahl sieht niedriger aus als erwartet. — Es werden nur die acht standardmäßigen HTTP-Methoden gezählt; Vendor-Erweiterungen wie x-amazon-apigateway-integration und parameters/servers-Einträge sind keine Operationen.
'The document is empty or not an object' nach dem Einfügen. — Die Eingabe wurde zu einem Skalar oder null geparst — stellen Sie sicher, dass Sie das gesamte Spec-Objekt eingefügt haben, nicht einen einzelnen String oder ein teilweises Fragment.

Häufig gestellte Fragen

Was ist ein OpenAPI-/Swagger-Formatter?: Es ist ein Tool, das eine OpenAPI-3.x- oder Swagger-2.0-API-Spezifikation parst und sie als sauberes, konsistent eingerücktes JSON oder YAML ausgibt, während es die Version und die Anzahl der Pfade und Operationen meldet, sodass Sie eine Spec schnell prüfen und standardisieren können.
Unterstützt es sowohl JSON- als auch YAML-Specs?: Ja. Da JSON selbst gültiges YAML ist, können Sie jedes Format einfügen. Verwenden Sie den JSON-/YAML-Schalter, um zu wählen, wie die formatierte Ausgabe ausgegeben wird, was es Ihnen auch erlaubt, eine Spec von einem Format in das andere zu konvertieren.
Validiert es meine Spec vollständig gegen das OpenAPI-Schema?: Es validiert, dass das Dokument als wohlgeformtes JSON oder YAML parst, und erkennt Version, Titel, Pfade und Operationen. Es führt keine vollständige JSON-Schema-Validierung jedes Felds durch, sodass es eine fehlende erforderliche Eigenschaft tief in einer Operation nicht kennzeichnet.
Welche Versionen erkennt es?: Es kennzeichnet OpenAPI 3.x über das openapi-Feld und Swagger 2.0 über das swagger-Feld. Jedes Dokument ohne eines dieser Felder wird formatiert, aber als unbekannte Version markiert.
Wird meine API-Spec irgendwohin hochgeladen?: Nein. Parsen, Validierung und Formatierung laufen vollständig in Ihrem Browser. Die eingefügte Spec verlässt niemals Ihr Gerät, und nichts wird zu ArrayKit hochgeladen, sodass interne oder unveröffentlichte API-Verträge privat bleiben.
Kann ich das formatierte Ergebnis herunterladen?: Ja. Die formatierte Spec kann je nach gewähltem Ausgabeformat kopiert oder als openapi.json oder openapi.yaml heruntergeladen werden.