Elysia Tools
Navegación
Workflow Playbook
Genera tipos y documentacion OpenAPI, revisa cambios incompatibles, valida respuestas y endurece el contrato con pruebas de estres y mutacion.
Temas
Este flujo sirve a equipos que ya tienen una fuente OpenAPI o Swagger y necesitan convertirla en evidencia de release. El contrato debe dirigir tipos TypeScript, documentacion, revision de compatibilidad, validacion de respuestas y pruebas defensivas sin que cada artefacto derive por separado.
Empieza con openapi-to-typescript-generator para que frontend, SDK e integraciones usen tipos de request y response acordes con la especificacion candidata. Luego usa api-doc-generator y revisa que descripciones, ejemplos, parametros y autenticacion coincidan con la superficie tipada.
Antes de publicar, ejecuta openapi-diff-breach-detector y api-breaking-changes-detector-migration-planner contra la version anterior. El resultado util no es solo una lista de rutas cambiadas; debe nombrar consumidores afectados, necesidad de compatibilidad o version nueva, y notas de migracion.
Usa api-response-contract-validator y api-response-diff-semantic-analyzer sobre payloads capturados para confirmar que la implementacion cumple el contrato. Termina con api-contract-stress-tester y api-contract-mutation-tester para explorar limites e inputs riesgosos. El flujo termina cuando existe una decision de release con evidencia.
Guía de flujo de trabajo
Parte del archivo OpenAPI o Swagger aprobado y genera tipos TypeScript de requests, responses y modelos para que SDK y frontend compartan el mismo vocabulario contractual.
Crea documentacion API legible desde la misma fuente y verifica que descripciones, parametros, ejemplos de respuesta y notas de autenticacion coincidan con los tipos.
Compara el contrato candidato con la version anterior, marca cambios incompatibles y conviertelos en acciones de migracion o compatibilidad antes de sorprender a consumidores.
Valida respuestas capturadas contra el schema declarado, clasifica drift semantico y ejecuta casos de limite y mutacion para probar la validacion defensiva.
Genera tipos y documentacion solo cuando la fuente OpenAPI ya sea candidata; usa diff y migracion primero si el riesgo principal es un cambio incompatible.
Usa validacion de respuesta y diff semantico para payloads observados; usa estres y mutacion cuando necesitas evidencia de rechazo correcto para limites e inputs riesgosos.