Formateador OpenAPI en línea — Embellecer JSON y YAML

Formatea documentos OpenAPI 3.0 a 3.2 (JSON o YAML) en el navegador, con indentación de 2 o 4 espacios y sin envío al servidor.

Cargando…
Documentación Formatear OpenAPI
Pretty-print de OpenAPI JSON o YAML en el navegador.

Notas para desarrolladores

Pretty-print genérico (JSON.stringify / yaml.dump) — ordenación recursiva de claves opcional para diffs estables. Se conserva el tipo de entrada: JSON → JSON; YAML → YAML. Autoformato al pegar/subir/ejemplo; las ediciones manuales usan Formatear (⌘↵). Los comentarios YAML se pierden al formatear. Las versiones openapi numéricas en YAML (p. ej. 3.0) se normalizan a cadenas (3.0.0). Máximo 512 KiB.

Opciones

Indentación
Espacios por nivel para JSON.stringify / yaml.dump (2 o 4).
Ordenar claves
Desactivado por defecto (conserva el orden de claves). Activado: ordena recursivamente las claves de objetos para diffs de PR estables; el orden de los elementos de arrays no cambia.

Casos de uso

Limpiar OpenAPI JSON/YAML minificado o editado a mano antes de la revisión. Normalizar la indentación (2 o 4 espacios) para diffs de PR. Encadenar con Validar OpenAPI después del formateo.

Ejemplos

JSON compacto → con indentación

Antes

{"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"}}}}}}

Después

{ "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" } } } } } }

YAML conservado como YAML

Antes

openapi: "3.0.3" info: title: Pets version: 1.0.0 paths: {}

Después

openapi: "3.0.3" info: title: Pets version: 1.0.0 paths: {}

FAQ Formatear OpenAPI

Preguntas frecuentes

¿El formato conserva JSON frente a YAML?

Sí. Una entrada JSON produce JSON con indentación y una entrada YAML produce YAML mediante yaml.dump. Los comentarios YAML no se conservan.

¿Es un pretty-printer consciente de OpenAPI?

El formato sigue siendo genérico (JSON.stringify / yaml.dump). Activa Ordenar claves para un orden alfabético recursivo y diffs estables. No es un reordenamiento que conozca la estructura de OpenAPI (paths antes que components, etc.).

¿Y openapi: 3.0 como número YAML?

Las versiones numéricas se normalizan a cadenas (3 → 3.0.0, 3.0 → 3.0.0) antes de la salida.

¿Qué versiones de OpenAPI?

OpenAPI 3.0, 3.1 y 3.2. Swagger 2.0 no se admite, así que usa nuestras herramientas OpenAPI solo para 3.x.

API y esquemas

Herramientas OpenAPI para formatear, validar y analizar tus specs.

Explorar otras categorías de herramientas