¿Esta herramienta es compatible con OpenAPI 3.1?

Sí. Soporta definiciones de OpenAPI 3.1, 3.0 y Swagger 2.0. La herramienta convierte la estructura subyacente sin alterar la versión de la especificación.

¿Mi documentación API se mantendrá privada?

Sí. La conversión se realiza completamente en tu navegador usando JavaScript. No se envían datos del documento a nuestros servidores ni se almacenan externamente.

¿Qué sucede con los comentarios YAML durante la conversión?

JSON no soporta comentarios, por lo que cualquier comentario en tu fuente YAML se eliminará al convertir a JSON. Se conservan si simplemente estás formateando YAML.

¿La salida se valida contra el esquema OpenAPI?

La herramienta verifica la sintaxis válida de `YAML` y `JSON` durante el proceso de conversión. Para una validación completa a nivel de esquema, recomendamos usar un linter de OpenAPI dedicado.

Formateadores y código

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 del editor

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

Este capítulo en profundidad está disponible solo en inglés por el momento. La herramienta de conversión de arriba funciona en tu idioma; el artículo explicativo extenso aún no se ha traducido.

Preguntas frecuentes

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.

La gente también busca

Herramientas relacionadas

More in this room.

Ver todo en Formateadores y código