Unterstützt dieses Tool OpenAPI 3.1?

Ja. Es unterstützt OpenAPI 3.1, 3.0 und Swagger 2.0 Definitionen. Das Tool konvertiert die zugrunde liegende Struktur ohne die Spezifikationsversion zu ändern.

Bleibt meine API-Dokumentation privat?

Ja. Die Konvertierung findet vollständig in Ihrem Browser mithilfe von JavaScript statt. Es werden keine Dokumentdaten an unsere Server gesendet oder extern gespeichert.

Was passiert mit YAML-Kommentaren während der Konvertierung?

JSON unterstützt keine Kommentare, daher werden alle Kommentare in Ihrer YAML-Quelle bei der Konvertierung in JSON entfernt. Sie bleiben erhalten, wenn Sie lediglich YAML formatieren.

Wird die Ausgabe gegen das OpenAPI-Schema validiert?

Das Tool prüft während des Konvertierungsprozesses auf gültige `YAML`- und `JSON`-Syntax. Für eine vollständige Validierung auf Schema-Ebene empfehlen wir die Verwendung eines dedizierten OpenAPI-Linters.

Formatierer & Code

OpenAPI 3.1 YAML ⇄ JSON

Convert OpenAPI specs between YAML and JSON.

Runs in your browser

OpenAPI YAML · source

lines: 42chars: 924size: 924 B

JSON · result

{
  "openapi": "3.0.3",
  "info": {
    "title": "AnytimeConvert API",
    "version": "1.0.0"
  },
  "paths": {
    "/tools": {
      "get": {
        "summary": "List all tools",
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "type": "array",
                  "items": {
                    "$ref": "#/components/schemas/Tool"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/tools/{slug}": {
      "get": {
        "summary": "Get a tool by slug",
        "parameters": [
          {
            "in": "path",
            "name": "slug",
            "required": true,
            "schema": {
              "type": "string"
            }
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/Tool"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "Tool": {
        "type": "object",
        "properties": {
          "slug": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "category": {
            "type": "string"
          }
        },
        "required": [
          "slug",
          "name",
          "category"
        ]
      }
    }
  }
}

lines: 79chars: 1576size: 1.5 KB

live

Anmerkung der Redaktion

Understanding · Same spec, two file formats — pick by audience.

Dieses ausführliche Kapitel ist derzeit nur auf Englisch verfügbar. Das Konvertierungstool oben funktioniert in Ihrer Sprache; der lange Erklärtext wurde noch nicht übersetzt.

Häufig gestellte Fragen

Quick answers.

›Does this tool support OpenAPI 3.1?

Yes. It supports OpenAPI 3.1, 3.0, and Swagger 2.0 definitions. The tool converts the underlying structure without altering the specification version.

›Will my API documentation be kept private?

Yes. The conversion happens entirely in your browser using JavaScript. No document data is sent to our servers or stored externally.

›What happens to YAML comments during conversion?

JSON does not support comments, so any comments in your YAML source will be stripped when converting to JSON. They are preserved if you are simply formatting YAML.

›Is the output validated against the OpenAPI schema?

The tool checks for valid `YAML` and `JSON` syntax during the conversion process. For full schema-level validation, we recommend using a dedicated OpenAPI linter.

Andere suchten auch nach

Verwandte Tools

More in this room.

Alle anzeigen in Formatierer & Code