Questo strumento supporta OpenAPI 3.1?

Sì. Supporta le definizioni OpenAPI 3.1, 3.0 e Swagger 2.0. Lo strumento converte la struttura sottostante senza alterare la versione della specifica.

La mia documentazione API sarà mantenuta privata?

Sì. La conversione avviene interamente nel browser utilizzando JavaScript. Nessun dato del documento viene inviato ai nostri server o archiviato esternamente.

Cosa succede ai commenti YAML durante la conversione?

JSON non supporta i commenti, quindi qualsiasi commento nella sorgente YAML verrà rimosso durante la conversione in JSON. Vengono preservati se si sta semplicemente formattando YAML.

L'output è validato rispetto allo schema OpenAPI?

Lo strumento verifica la sintassi `YAML` e `JSON` valida durante il processo di conversione. Per una convalida completa a livello di schema, consigliamo di utilizzare un linter OpenAPI dedicato.

Formattatori e Codice

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

Nota dell'editore

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

Questo capitolo approfondito è attualmente disponibile solo in inglese. Lo strumento di conversione qui sopra funziona nella tua lingua; il lungo articolo esplicativo non è stato ancora tradotto.

Domande frequenti

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.

Le persone cercano anche

Strumenti correlati

More in this room.

Vedi tutto in Formattatori e Codice