OpenAPI Formatter Online – Verschönern Sie die Spezifikationen für JSON und YAML

Drucken Sie OpenAPI 3.0–3.2-Dokumente (JSON oder YAML) hübsch in Ihrem Browser aus – mit 2 oder 4 Leerzeichen Einzug, nichts hochgeladen.

0 chars · 0 B

Einzug

Sortierschlüssel

Teilen Sie dieses Tool:

OpenAPI Dokument

Formatierte Ausgabe

Die Formatierung erfolgt in Ihrem Browser – es wird nichts hochgeladen.

Laden…

Formatieren Sie die OpenAPI-Dokumentation

Drucken Sie im Browser hübsch OpenAPI JSON oder YAML aus.

Hinweise des Entwicklers

• Generisches Pretty-Print (JSON.stringify / yaml.dump) – optionale rekursive Schlüsselsortierung für stabile Unterschiede. • Eingabeart bleibt erhalten: JSON in → JSON out; YAML rein → YAML raus. • YAML Kommentare gehen beim Formatieren verloren. • Numerische openapi-Versionen in YAML (z. B. 3.0) werden auf Zeichenfolgen (3.0.0) normalisiert. • Maximale Eingabe 512 KiB.

Optionen

Einzug

Leerzeichen pro Ebene für JSON.stringify / yaml.dump (2 oder 4).

Sortierschlüssel

Standardmäßig deaktiviert (behält die Tastenreihenfolge bei). Sortiert rekursiv Objektschlüssel für stabile PR-Unterschiede; Die Reihenfolge der Array-Elemente bleibt unverändert.

Anwendungsfälle

• Bereinigen Sie verkleinerte oder handbearbeitete OpenAPI JSON/YAML vor der Überprüfung. • Normalisieren Sie die Einrückung (2 oder 4 Leerzeichen) für PR-Unterschiede. • Nach der Formatierung mit Validate OpenAPI koppeln.

Beispiele

Kompakt JSON → eingerückt

Vor

{"openapi":"3.1.0","info":{"title":"Pets API","version":"1.0.0","description":"Simple pet store API"},"paths":{"/pets":{"get":{"operationId":"listPets","tags":["pets"],"summary":"List pets","parameters":[{"name":"limit","in":"query","schema":{"type":"integer"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Pet"}}}}}}}}},"components":{"schemas":{"Pet":{"type":"object","required":["id","name"],"properties":{"id":{"type":"integer"},"name":{"type":"string"}}}}}}

Nach

{
  "openapi": "3.1.0",
  "info": {
    "title": "Pets API",
    "version": "1.0.0",
    "description": "Simple pet store API"
  },
  „Pfade“: {
    "/pets": {
      "get": {
        "operationId": "listPets",
        "tags": [
          "pets"
        ],
        "summary": "List pets",
        "parameters": [
          {
            "name": "limit",
            "in": "query",
            "schema": {
              "type": "integer"
            }
          }
        ],
        „Antworten“: {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Pet"
                  }
                }
              }
            }
          }
        }
      }
    }
  },
  „Komponenten“: {
    "schemas": {
      "Pet": {
        "type": "object",
        "required": [
          "id",
          "name"
        ],
        "properties": {
          "id": {
            "type": "integer"
          },
          „Name“: {
            "type": "string"
          }
        }
      }
    }
  }
}

YAML bleibt als YAML erhalten

Vor

openapi: „3.0.3“
Infos:
  Titel: Haustiere
  Version: 1.0.0
Pfade: {}

Nach

openapi: „3.0.3“
Infos:
  Titel: Haustiere
  Version: 1.0.0
Pfade: {}

Format OpenAPI FAQ

Häufige Fragen

Behält das Format JSON gegenüber YAML bei?

Ja. Die Eingabe JSON erzeugt ein eingerücktes JSON; Die Eingabe YAML erzeugt YAML über yaml.dump. Kommentare in YAML bleiben nicht erhalten.

Ist das ein OpenAPI-fähiger hübscher Drucker?

Pretty-Print ist immer noch generisch (JSON.stringify / yaml.dump). Aktivieren Sie Sortierschlüssel für eine rekursive alphabetische Schlüsselreihenfolge (stabile Unterschiede). Es handelt sich nicht um eine OpenAPI-bewusste Neuordnung (Pfade vor Komponenten usw.).

Was ist mit openapi: 3.0 als YAML-Nummer?

Numerische Versionen werden vor der Ausgabe auf Zeichenfolgen normalisiert (3 → 3.0.0, 3.0 → 3.0.0).

Welche OpenAPI-Versionen?

OpenAPI 3.0, 3.1 und 3.2. Swagger 2.0 wird nicht unterstützt – verwenden Sie unsere OpenAPI-Tools nur für 3.x.

Weitere API- und Schema-Tools in diesem Cluster

Formatieren Sie OpenAPIOpenAPI validieren Flusen OpenAPI JSON 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.