Saltar al contenido

Validador de OpenAPI

Comprueba un documento OpenAPI 3.0, 3.1 o 3.2, o Swagger 2.0, en YAML o JSON y obtén un resumen de sus endpoints y esquemas. El validador comprueba los campos obligatorios, las plantillas de ruta frente a los parámetros de ruta, las ubicaciones de los parámetros, los códigos de respuesta, los ID de operación duplicados y cada $ref local, y enumera cada problema con su ubicación.

Restablecer

Preguntas frecuentes

¿Qué comprueba el validador?

Comprueba la versión de openapi o swagger, info.title y info.version, que las rutas empiecen por una barra, que cada {parameter} de una ruta tenga un parámetro de ruta obligatorio correspondiente y viceversa, los nombres y ubicaciones de los parámetros, los códigos de estado y las descripciones de las respuestas, los parámetros duplicados, los valores operationId duplicados y que cada $ref local apunte a algo dentro del documento.

¿Valida toda la especificación según el esquema JSON?

No. Comprueba las reglas estructurales anteriores, que detectan la mayoría de los errores en documentos escritos a mano, pero no valida todos los campos según el metaesquema oficial ni comprueba el contenido de tus esquemas.

¿Qué muestra el resumen?

La especificación y la versión API, el título, una tabla con todos los endpoints y sus métodos, rutas, operationId, resúmenes y códigos de respuesta, y los nombres de los esquemas bajo components.schemas o, en Swagger 2.0, bajo definitions.

¿Se siguen las referencias externas?

No. No se obtienen ni se notifican las referencias a otros archivos o URL. Solo se resuelven dentro del documento pegado las referencias que empiezan por #.

¿Cuál es la diferencia entre errores y advertencias?

Los errores incumplen una regla de la especificación; por ejemplo, falta una descripción de respuesta o no se declara un parámetro de ruta. Las advertencias señalan elementos permitidos, pero que normalmente no son intencionados, como una operación GET con cuerpo de solicitud o un documento sin ningún operationId.

¿OpenAPI 3.1 cambia los requisitos?

Sí. En OpenAPI 3.1 y 3.2, una operación ya no necesita un objeto responses, y un documento puede incluir webhooks o components en lugar de paths. El validador aplica esas reglas cuando el campo openapi empieza por 3.1 o 3.2.

Acerca de OneClick Pro

OneClick Pro es una colección gratuita de más de 150 herramientas web para las tareas cotidianas: convertir imágenes y unidades, dar formato y validar código, consultar dominios y SEO, y trabajar con texto, fechas y números. Todas las herramientas funcionan sin registro ni suscripción; los datos que introduce solo se utilizan para calcular el resultado y nunca se almacenan. Úsela como una caja de herramientas para tareas puntuales o añada a favoritos las que utiliza a diario.