Herramientas y scripts de IA
API Change Report: qué puede romperse a los consumidores de tu API, a partir de dos especificaciones
Para equipos de API y agencias: un script compara tu archivo OpenAPI o Swagger antiguo y el nuevo con reglas fijas, y tu agente redacta un informe de cambios potencialmente incompatibles, una guía de migración, una entrada de registro de cambios y un aviso para integradores, para que los revises. Informe de lo que puede romperse a los consumidores de la API entre dos versiones.
Qué recibes: 1 archivo · 76.62 KB · ZIP
Ver opciones de compraDescripción del producto
Descripción
Para desarrolladores de backend, equipos de API y agencias que publican una nueva versión de una API HTTP y tienen que contar a quienes la llaman qué ha cambiado.
Dale a tu agente la descripción antigua y la nueva de tu API (OpenAPI 3.x o Swagger 2.0, JSON o YAML). El agente redacta un informe de cambios, una guía de migración y un aviso para integradores, para que los revises antes de publicar.
El informe lista los cambios potencialmente incompatibles encontrados al comparar los dos archivos. Es un punto de partida para la revisión de tu equipo, no una evaluación de compatibilidad confirmada.
Un script incluido compara los dos archivos y clasifica cada diferencia según reglas fijas. Después el agente escribe qué significa cada cambio para un cliente: qué verá y qué tiene que cambiar.
Qué escribe el agente en cada ejecución
changes.jsonychanges.csv: cada diferencia con un identificador, una clase (incompatible, potencialmente incompatible, compatible, solo documentación), su tipo, el método y la ruta, y el valor antiguo y el nuevo.change-report.mdychange-report.html: los recuentos del resumen y después los cambios incompatibles primero, cada uno con dónde está, qué cambió, qué verá un cliente y qué debe cambiar. El HTML es una página imprimible sin archivos externos.migration-guide.md: pasos para los desarrolladores que llaman a la API, con fragmentos de antes y después tomados de los dos archivos.changelog-entry.md: una entrada de registro de cambios y un cambio de versión sugerido con su razonamiento. Decide el equipo.consumer-notice.md: un anuncio breve y objetivo para integradores.notes.md: qué se comparó, qué no puede mostrar la comparación de dos archivos y qué requiere una decisión.
Reglas, no suposiciones
El script conoce 118 tipos de cambio en cuatro clases, con reglas distintas para lo que un cliente envía y lo que recibe: un nuevo campo obligatorio en la petición es incompatible, un nuevo campo en la respuesta no. Sigue los $ref locales. Ejecuta api_diff.py rules para leer todas las reglas. Después check confirma que cada identificador incompatible está cubierto en el informe y en la guía.
Solo tus datos
La skill indica al agente que tome fragmentos, rutas y valores de tus dos archivos, y que marque lo que no hayas aportado, como la fecha de cierre de la versión antigua, como [NEEDS: ...] en lugar de inventarlo.
Honestidad sobre sus límites
Compara dos archivos. No llama a tu API, así que el comportamiento que la descripción no indica queda fuera de su vista. Las clases salen de reglas y es tu equipo quien debe confirmarlas. Solo se siguen los $ref locales: una especificación repartida en varios archivos da un aviso y una comparación incompleta. El lector de YAML cubre el subconjunto habitual e indica la línea cuando encuentra algo distinto (convierte ese archivo a JSON). Las expresiones regulares y oneOf / anyOf se informan como cambiadas sin evaluarse. No se comparan las cabeceras de respuesta, los enlaces, los callbacks ni los webhooks. Sin especificación, el agente puede comparar una lista sencilla de endpoints que construye a partir de tus archivos de rutas; ese camino es más débil y no se ejecutó de principio a fin en las pruebas. La página HTML se comprobó leyendo su código fuente, no en un navegador.
Árabe
Si lo pides, el informe, la guía y el aviso se escriben en árabe y la página HTML se dispone de derecha a izquierda, con las rutas y el JSON de izquierda a derecha.
En la descarga: SKILL.md, cuatro scripts de Python de biblioteca estándar, referencias (las reglas, cómo escribir cada entrada, formatos de entrada, notas sobre el árabe), plantillas y un ejemplo resuelto que puedes leer antes de comprar: una API de pagos que pasa de la 1.8.0 a la 2.0.0, con 75 diferencias agrupadas en 11 entradas incompatibles.
Probado en dos casos (una API de pagos en OpenAPI 3 YAML en inglés; una API de una clínica en Swagger 2.0 JSON con informe en árabe). Los scripts tienen 85 pruebas unitarias.
Versión breve
Para desarrolladores de backend y equipos de API que publican una nueva versión y necesitan contar a sus usuarios qué ha cambiado.
Dale a tu agente el archivo de descripción de la versión antigua y el de la nueva (OpenAPI 3 o Swagger 2, en JSON o YAML). Te redacta borradores del informe de cambios, de la guía de migración y de un aviso para desarrolladores, para que los revises antes de publicar.
Qué escribe el agente
- Los archivos
changes.jsonychanges.csv: cada diferencia con su número, clase, lugar y el valor antiguo y el nuevo. - El archivo
change-report: primero los cambios incompatibles y, con cada uno, qué verá el cliente y qué debe cambiar. - El archivo
migration-guide.md: pasos de migración con fragmentos de antes y después tomados de tus archivos. - Los archivos
changelog-entry.mdyconsumer-notice.md: la entrada del registro de cambios y un aviso breve.
Sus límites
Los resultados son cambios que podrían ser incompatibles y que necesitan la revisión de tu equipo. La skill compara dos archivos y no llama a la API, así que no ve lo que la descripción no indica. La clasificación se basa en reglas fijas y la confirma tu equipo. Solo sigue las referencias dentro del mismo archivo. El informe puede pedirse en árabe con una página de derecha a izquierda; se probó en un caso de prueba.
Preguntas
¿Qué formatos lee?
OpenAPI 3.x y Swagger 2.0, en JSON o YAML. El lector de YAML cubre el subconjunto habitual e indica la línea si encuentra una característica que no lee; convierte ese archivo a JSON.
¿Llama a mi API?
No. Compara dos archivos de tu disco. El comportamiento que la descripción no indica queda fuera de su vista.
¿Cómo decide qué es incompatible?
Con reglas fijas que puedes leer con el comando rules: 118 tipos de cambio en cuatro clases, con reglas distintas para lo que un cliente envía y lo que recibe. Tu equipo confirma las clases.
¿Qué pasa si mi especificación está repartida en varios archivos?
Solo se siguen las referencias dentro del mismo archivo. Agrupa antes la especificación en un solo archivo; si no, recibirás un aviso y una comparación incompleta.
¿Inventará una fecha de cierre?
La skill indica al agente que no lo haga. Las fechas y plazos que no hayas aportado se marcan con [NEEDS: ...] para que los completes.
¿Puede el informe estar en árabe?
Sí, como opción adicional, con una página HTML de derecha a izquierda y las rutas de izquierda a derecha. Se probó en un caso de prueba; léelo antes de publicarlo.
Qué recibes
1 archivo · 76.62 KB
- api-change-report-1.0.0.zipZIP · 76.62 KB
Herramientas y scripts de IA
API Change Report: qué puede romperse a los consumidores de tu API, a partir de dos especificaciones
Para equipos de API y agencias: un script compara tu archivo OpenAPI o Swagger antiguo y el nuevo con reglas fijas, y tu agente redacta un informe de cambios potencialmente incompatibles, una guía de migración, una entrada de registro de cambios y un aviso para integradores, para que los revises. Informe de lo que puede romperse a los consumidores de la API entre dos versiones.
Getly abrió los archivos subidos y no encontró nada que impida abrirlos. No es un análisis antivirus ni una valoración de calidad.
Etiquetas
Preguntas frecuentes
¿Tengo acceso al instante?
Sí. Es un producto digital: puedes descargarlo justo después del pago, directamente desde tu biblioteca.
¿Puedo usarlo en proyectos comerciales?
Sí. Se permite el uso comercial: úsalo en tu propio negocio y en cosas que vendas. No puedes revender ni redistribuir el archivo en sí.
¿Cuál es vuestra política de reembolso?
Puedes pedir un reembolso dentro de 30 días. Si algo no va bien, solicítalo desde tu pedido y el equipo de Getly lo revisa.
¿Qué formatos y tamaños de archivo recibiré?
Descargarás 1 archivo - ZIP - 76.62 KB en total.
¿Recibo actualizaciones gratis?
Sí: cuando el vendedor publica una versión nueva, puedes volver a descargar los archivos más recientes desde tu biblioteca sin coste extra. Mira el registro de cambios para ver las últimas actualizaciones.
Precio
$7.00



