ToolRobinSin iniciar sesión, úsalo al instante

Comprobador de compatibilidad de OpenAPI

Compare dos especificaciones de OpenAPI 3.x localmente y revise los cambios de contrato de API potencialmente importantes por operación y ruta de campo.

Pegue o elija los archivos OpenAPI 3.0, 3.1 o 3.2 originales y revisados. Verifique la gravedad y la ruta del campo afectado, luego descargue un informe Markdown o JSON para revisarlo.

Compara dos archivos OpenAPI antes de su lanzamiento. Las especificaciones permanecen en este navegador.

Pegue JSON o YAML a continuación, o elija un archivo.
Pegue JSON o YAML a continuación, o elija un archivo.

Cada archivo: hasta 2 MB y 1.000 operaciones. Soporta OpenAPI 3.0, 3.1 y 3.2.

Cómo utilizar

Revisar los cambios de OpenAPI antes de lanzar una API

Compare dos especificaciones de OpenAPI 3.x localmente y revise los cambios de contrato de API potencialmente importantes por operación y ruta de campo.

Paso a paso

  1. Introduce la fuente mediante: Especificaciones originales / Especificación revisada.
  2. Ejecuta: Verificar compatibilidad. Revisa el resultado antes de copiarlo, descargarlo o usarlo en otro lugar.
  3. Pegue o elija los archivos OpenAPI 3.0, 3.1 o 3.2 originales y revisados. Verifique la gravedad y la ruta del campo afectado, luego descargue un informe Markdown o JSON para revisarlo.

Cómo elegir los ajustes

OpciónQué cambia
Especificaciones originalesSe siguen las referencias dentro de un archivo de especificación. Las referencias a archivos externos o URL no se recuperan y aparecen como resultados de la revisión. Los esquemas recursivos se comparan en su primera aparición y se marcan para su revisión.
Verificar compatibilidadEl verificador compara operaciones, parámetros, cuerpos de solicitud, códigos de respuesta y tipos de medios, además de cambios de esquema comunes, como propiedades eliminadas, propiedades de solicitud recientemente requeridas, cambios de tipo y valores de enumeración. Los hallazgos incluyen la operación afectada y la ruta de campo.

Ejemplo y resultado esperado

Si la respuesta GET /users/{id} revisada requiere un campo `email` opcional, el informe marca el contrato de respuesta modificado. Se siguen las referencias locales `$ref`; Las referencias externas y la composición compleja de esquemas se solicitan para revisión manual. Este no es un validador de especificaciones completo ni una prueba de la API en ejecución.

Si no funciona

  • El resultado es una revisión estática del contrato, no un validador de conformidad OpenAPI completo, una prueba de API en tiempo de ejecución o una auditoría de seguridad. El comportamiento del servidor, la lógica de autorización y la composición compleja del esquema pueden requerir una revisión manual. El informe indica qué referencias o estructuras recursivas no se comprobaron completamente.
  • Si falla el análisis, revisa la sintaxis JSON o YAML antes de los hallazgos de la API. Incluye las referencias locales necesarias en el mismo documento. Las referencias externas sin resolver y los esquemas no admitidos requieren revisión manual; no se descargan ni se prueba el servidor.

¿Qué cambios se verifican?

El verificador compara operaciones, parámetros, cuerpos de solicitud, códigos de respuesta y tipos de medios, además de cambios de esquema comunes, como propiedades eliminadas, propiedades de solicitud recientemente requeridas, cambios de tipo y valores de enumeración. Los hallazgos incluyen la operación afectada y la ruta de campo.

¿Cómo se manejan las referencias?

Se siguen las referencias dentro de un archivo de especificación. Las referencias a archivos externos o URL no se recuperan y aparecen como resultados de la revisión. Los esquemas recursivos se comparan en su primera aparición y se marcan para su revisión.

¿Qué hay fuera de este cheque?

El resultado es una revisión estática del contrato, no un validador de conformidad OpenAPI completo, una prueba de API en tiempo de ejecución o una auditoría de seguridad. El comportamiento del servidor, la lógica de autorización y la composición compleja del esquema pueden requerir una revisión manual. El informe indica qué referencias o estructuras recursivas no se comprobaron completamente.

Es posible que también necesites