YAMLTools logo
Gratis · sin registro · en tu navegador

Validador de OpenAPI

Pega tu especificación OpenAPI o Swagger y compruébala antes de generar clientes o publicar la documentación: estructura, referencias y coherencia entre rutas y parámetros.

OpenAPI
YAML
Loading editor…

Pega un fichero a la izquierda para validarlo.

CREA.MBA
CREA.MBA

Lanza tu producto más rápido con Next.js preparado para IA

El boilerplate diseñado para que la IA entienda tu proyecto. ¡Usa el código YAMLTOOLS y obtén un 5% de descuento!

Empieza a Crear
Anuncio

¿Tu infraestructura es un lío? En IPalSeb Studio te ayudamos

Qué comprueba YAMLTools en tu fichero de OpenAPI

  • El documento contra el esquema oficial de OpenAPI 3.x (y Swagger 2.0).
  • $ref que apuntan a componentes que no existen, por ejemplo un nombre de schema mal escrito.
  • Parámetros de ruta como {id} que no están declarados en parameters, o declarados y sin usar.
  • operationId duplicados, que rompen los generadores de código.
  • Operaciones sin respuesta de éxito, tags sin declarar y schemas que nadie usa.

Riesgos que señala

  • Operaciones sin requisito de seguridad cuando la API declara uno.
  • API keys enviadas en la query string.
  • Servidores declarados con http:// sin cifrar.
  • Entradas sin límites (cadenas y arrays sin maxLength ni maxItems).
  • Objetos que aceptan cualquier propiedad extra, y el flujo implícito de OAuth2, obsoleto.

Errores frecuentes en OpenAPI

Los que más a menudo rompen un despliegue, y cómo los señala YAMLTools.

$ref roto

$ref: "#/components/schemas/Prodcut"

Los generadores y la documentación fallan en ese endpoint. YAMLTools marca la referencia que no se resuelve.

Parámetro de ruta sin declarar

/products/{id}:
  get:
    # sin parameters: id

Cada {marcador} de la ruta necesita un parámetro con in: path y required: true.

operationId duplicado

operationId: getProduct   # usado dos veces

Dos métodos con el mismo nombre en el SDK generado. El informe lista las dos operaciones.

Tu fichero se queda en tu ordenador

La validación, el análisis de riesgos, el diagrama y las conversiones se ejecutan en tu navegador. No se sube nada salvo que decidas guardarlo con una cuenta.

Preguntas frecuentes del validador de OpenAPI

Versiones, referencias y qué pasa con tu especificación.