Muestra una definición OpenAPI o Swagger en local

Pega una definición autocontenida para explorar operaciones, cuerpos de petición, respuestas y esquemas sin enviarla a ningún sitio. El visor comprueba la versión y resuelve cada referencia dentro del documento pegado antes de renderizar.

VISOR LOCALSwagger UI 5.32.14OpenAPI 3.x · Swagger 2.0Ejecución de endpoints desactivada
Tu definición se renderiza en este navegador. Cada $ref debe resolverse dentro del documento pegado; las URL externas, las rutas de archivo relativas, las llamadas de validación y las peticiones Try it out están bloqueadas, y ninguna petición sale del navegador.
Documento OpenAPI o Swagger
Vista previa de la documentación
Pega un documento OpenAPI o Swagger y luego renderiza la documentación local.

Revisa la documentación sin activar un cliente de API

Este visor sirve para revisar el contrato de forma visual: nunca envía peticiones, no guarda autorizaciones, no descarga definiciones remotas ni resuelve referencias fuera del documento pegado. Usa el Explorador cuando quieras generar una petición a partir de detalles copiados.

Cómo renderizar una definición API en local

Pega una definición OpenAPI 3.x o Swagger 2.0 y léela como documentación de Swagger UI sin enviarla a ningún sitio. El análisis, la comprobación y el renderizado ocurren en esta pestaña, Try it out está desactivado y el número de peticiones medidas al renderizar es cero.

El visor comprueba antes la definición. La raíz debe llevar una versión admitida, cada $ref debe apuntar dentro del mismo documento y todas esas referencias deben resolverse; cualquier otro caso se avisa en la línea de estado en lugar de dejar una página a medio renderizar.

  1. Pega una definición JSON o YAML, o pulsa Cargar ejemplo para ver una API de notas con dos operaciones.
  2. Pulsa Renderizar documentación local. El JSON y el YAML se leen en el navegador; un problema de YAML indica la línea y uno de JSON indica la posición.
  3. Despliega una operación para leer parámetros, cuerpo de la petición, respuestas y esquemas. Aquí las operaciones son solo documentación: no se dibuja ningún botón de petición.
  4. Limpiar vacía el campo y la vista previa. Después de renderizar, si editas el documento la vista previa se atenúa y queda marcada como del documento anterior hasta que vuelvas a renderizar.

Qué comprueba el visor antes de renderizar

Qué puede contener la definición

Se aceptan raíces OpenAPI 3.x y Swagger 2.0; el campo de versión es obligatorio y openapi: 4.x se rechaza con un mensaje en lugar de una página de error de Swagger UI. Se analizan tanto el JSON como el subconjunto de YAML que usan los archivos OpenAPI: mapas, secuencias, colecciones en línea [] y {}, claves entrecomilladas, comentarios, escalares de bloque | y > con chomping, anclas y alias (&nombre / *nombre) y las etiquetas !!str, !!int, !!float, !!bool y !!null. Un segundo documento tras --- se informa como error en vez de fusionarse con el primero.

Referencias y peticiones de red

Solo se admiten referencias dentro del documento pegado. ./schemas/a.json, a.yaml, las rutas relativas y las URL http(s) se rechazan antes de renderizar, y el mensaje indica la propiedad que las contiene, así que una definición que apunta a un archivo relativo se avisa en lugar de pedirlo en silencio a este sitio. Las referencias locales como #/components/schemas/Note se resuelven contra el documento pegado, y una referencia a un nodo inexistente se avisa en el momento en lugar de fallar al desplegar la operación.

Cómo leer el resultado

La vista previa lista las operaciones con sus parámetros, cuerpos de petición, respuestas y esquemas con el diseño base de Swagger UI, sin botón Try it out ni formulario de autorización. Medido en esta versión: el ejemplo incluido renderiza dos operaciones, una definición de 200 operaciones tarda alrededor de un cuarto de segundo y renderizar dos veces el mismo documento no duplica la vista previa.

Herramientas recientes: