A) ¿Empiezas con OpenAPI o B) con una muestra JSON?
Elige A si ya existe el contrato y necesitas documentación y tipos. Elige B si solo hay cargas, pero revisa el esquema inferido antes de adoptarlo.
Elysia Tools
Navegación
Workflow Playbook
Define un contrato API, valida esquemas y cargas capturadas, detecta riesgos de compatibilidad y registra la aceptación.
Temas
Define un contrato API, valida esquemas y cargas capturadas, detecta riesgos de compatibilidad y registra la aceptación.
Esta guía convierte el alcance indicado en un resultado revisable. Conserve la fuente, los resultados intermedios y las decisiones para que la siguiente persona entienda qué se comprobó y por qué.
Prepara una fuente OpenAPI o JSON Schema, o una carga JSON representativa.
Fija la política de compatibilidad, campos obligatorios, casos y umbrales de aceptación.
Decisión: A) ¿Empiezas con OpenAPI o B) con una muestra JSON?. Elige A si ya existe el contrato y necesitas documentación y tipos. Elige B si solo hay cargas, pero revisa el esquema inferido antes de adoptarlo.
Genera tipos y documentación desde OpenAPI, o crea un esquema inicial desde una muestra; conserva versión y casos para la revisión. Usar openapi-to-typescript-generator, api-doc-generator, json-schema-generator.
Comprueba cargas normales y de error, convierte el esquema para validación en ejecución si hace falta y clasifica cambios incompatibles entre versiones. Usar json-schema-validator, json-schema-to-zod-schema-converter, openapi-diff-breach-detector, api-breaking-changes-detector-migration-planner.
Valida respuestas capturadas, compara cargas conocidas y genera casos límite o mutaciones; registra hallazgos sin prometer despliegue ni monitorización real. Usar api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester, api-mock-server.
Guía de flujo de trabajo
Genera tipos y documentación desde OpenAPI, o crea un esquema inicial desde una muestra; conserva versión y casos para la revisión.
Comprueba cargas normales y de error, convierte el esquema para validación en ejecución si hace falta y clasifica cambios incompatibles entre versiones.
Valida respuestas capturadas, compara cargas conocidas y genera casos límite o mutaciones; registra hallazgos sin prometer despliegue ni monitorización real.
Elige A si ya existe el contrato y necesitas documentación y tipos. Elige B si solo hay cargas, pero revisa el esquema inferido antes de adoptarlo.