Herramientas API

Editor OpenAPIrevisa el contrato

Introduce una especificación JSON o YAML y explora operaciones y diagnósticos antes de exportar.

Editor OpenAPI

Fuente OpenAPI

Resultado

No hay endpoints de solicitud coincidentes.

Mostrando 0 de 0

La especificación se procesa en este navegador. No se envían peticiones API ni se descargan referencias remotas.

Opciones de salida

Comprueba la estructura y reglas habituales de rutas. La exportación incluye paths, sin webhooks ni callbacks. No prueba ejemplos ni respuestas reales.

500.000 caracteres · profundidad 60 · 50.000 nodos · 100 diagnósticos · 5 segundos para validar.

Pega una especificación o carga el ejemplo.

Se copia o descarga la vista seleccionada. La lista de endpoints se exporta completa, independientemente de la búsqueda.

El Editor OpenAPI sirve para revisar contratos generados que resultan difíciles de recorrer. Un archivo con sintaxis correcta todavía puede omitir una descripción de respuesta o un parámetro de ruta obligatorio.

Primero comprueba la versión declarada. El formato determina cómo se escribe el documento; la validación revisa su estructura. Ninguno de los dos prueba el comportamiento del servicio desplegado.

Por qué usar este Editor OpenAPI

Relaciona cada definición con las operaciones que la necesitan.

Explorar rutas con sus parámetros

El Editor OpenAPI agrupa las operaciones bajo rutas de solicitud. Al desplegarlas aparecen parámetros heredados, cuerpos, respuestas, servidores y seguridad. La búsqueda filtra la vista, mientras que la exportación conserva la lista completa.

Un documento estructurado se ramifica en tres tarjetas de endpoints con marcas de método de distintos colores.

Distinguir referencias pendientes

Los JSON Pointer locales se buscan dentro del documento. Los destinos inexistentes producen errores y los modelos recursivos mantienen sus enlaces. Las referencias externas muestran que la comprobación está incompleta.

Modelos unidos por referencias locales junto a un enlace roto con una señal de advertencia.

Tres decisiones antes de entregar el contrato

01

Leer el campo de versión

openapi o swagger selecciona las reglas. En 3.1 puede existir un documento válido con solo components, aunque no aparezcan endpoints de solicitud.

  • El ejemplo incluye un parámetro compartido y un modelo recursivo.
02

Revisar los parámetros efectivos

Una operación sustituye el parámetro de ruta que tenga el mismo nombre y ubicación. La lista muestra ese resultado combinado, no dos entradas independientes.

  • Desactiva el modo automático para ejecutar con Ctrl/Cmd + Enter.
03

Escoger la vista de exportación

La especificación formateada sirve para seguir editando; Endpoints entrega todo el inventario JSON y Markdown genera documentación con parámetros y respuestas.

  • Al cambiar la entrada o las opciones se bloquea la exportación del resultado anterior.

Estructura, coherencia y documentación

Validador OpenAPI por versión

Se aplican esquemas reales para Swagger 2.0 y OpenAPI 3.0/3.1. También se revisa la forma de las palabras clave estándar JSON Schema 2020-12 en modelos 3.1, incluidos los nombres de tipo.

Reglas de rutas y operaciones

Detecta ID de operación repetidos, parámetros duplicados y parámetros de ruta sin declarar o sin marcar como obligatorios. servers, parameters y extensiones x no cuentan como operaciones HTTP.

Formateador OpenAPI con dos salidas

Convierte JSON y YAML con sangría de dos o cuatro espacios. Conserva valores, referencias y versión. No convierte automáticamente las definiciones de Swagger 2.0 a la estructura de OpenAPI 3.

Markdown para revisión

El documento incluye información de la API, servidores y detalles de las operaciones. Las descripciones se escapan y los bloques de código se delimitan de forma segura; la vista no ejecuta HTML de la especificación.

Qué cubre la revisión

Un único documento
Se admiten Swagger 2.0 y OpenAPI 3.0.x/3.1.x. La versión 3.2 y otras familias se rechazan explícitamente. Una referencia local apunta dentro de esta entrada, no a otro archivo del equipo.
Referencias y dialectos avanzados
No se descargan URL ni archivos relativos. Los ID de recursos, anclas, referencias dinámicas y dialectos personalizados generan una advertencia de revisión incompleta. Agrupa las dependencias antes en un entorno de confianza.
YAML se vuelve a escribir
Los comentarios y estilos de comillas no se conservan. Se requiere YAML 1.2 de un solo documento con claves de texto. Se rechazan anclas, alias, fusiones, etiquetas personalizadas, claves duplicadas y números que perderían precisión.
Solo endpoints de solicitud
La lista incluye operaciones bajo paths. Webhooks y callbacks reciben revisión estructural, pero se excluyen del inventario y de las reglas semánticas de rutas. Ejemplos, respuestas reales y autenticación necesitan pruebas aparte.
Procesamiento limitado
Hasta 500.000 caracteres de entrada, profundidad 60 y 50.000 nodos. Se detiene al superar 100 diagnósticos, 2.000.000 de caracteres de resultado o cinco segundos. Divide una especificación grande para revisarla por partes.

Preguntas sobre el Editor OpenAPI

¿Se admiten especificaciones JSON y YAML?

Sí. Puedes seleccionar un formato de salida distinto al de entrada. En YAML, las claves como los códigos de respuesta deben escribirse como cadenas. No se conservan comentarios ni estilos de comillas.

¿La validación de la especificación es completa?

Se comprueban la estructura, palabras clave estándar, referencias locales y reglas comunes de rutas. Las dependencias externas o dialectos avanzados quedan señalados como incompletos; no se prueban respuestas reales.

¿Qué versiones se reconocen?

Swagger 2.0 y OpenAPI 3.0.x/3.1.x. El campo raíz selecciona las reglas. Versiones no admitidas, como 3.2, generan un aviso de rechazo en vez de aplicar reglas equivocadas.

¿Se sube mi especificación a algún servidor?

No. El análisis y la validación se ejecutan en un worker del navegador. Tampoco se accede a las URL incluidas en el documento. Al recargar no se recupera automáticamente la entrada.

¿Puedo descargar el resultado formateado?

Sí. Selecciona la vista para descargar la especificación, todo el inventario de endpoints o Markdown. Si hay errores o el resultado está desactualizado, la exportación queda desactivada.

¿Un documento da un resultado inesperado?

Revisa la siguiente especificación

Usa el Editor OpenAPI para comprobar la versión, resolver los diagnósticos y compartir el resultado adecuado.

El formato de salida conserva la versión original.