Elysia Tools
Navegação
Workflow Playbook
Defina um contrato de API, valide schemas e payloads capturados, encontre riscos de compatibilidade e registre a aceitação.
Temas
Defina um contrato de API, valide schemas e payloads capturados, encontre riscos de compatibilidade e registre a aceitação.
Este guia transforma o escopo informado em um resultado revisável. Mantenha a fonte, os resultados intermediários e as decisões para que a próxima pessoa entenda o que foi verificado e por quê.
Prepare uma fonte OpenAPI ou JSON Schema, ou um payload JSON representativo.
Defina a política de compatibilidade, campos obrigatórios, casos e limites de aceitação.
Decisão: A) Começar com OpenAPI ou B) com um exemplo JSON?. Escolha A quando o contrato já existir e precisar gerar documentação e tipos. Escolha B quando só houver payloads, revisando o schema inferido antes de adotá-lo.
Gere tipos e documentação a partir de OpenAPI ou um schema inicial de um exemplo; mantenha versão e casos na revisão. Usar openapi-to-typescript-generator, api-doc-generator, json-schema-generator.
Valide payloads normais e de erro, converta o schema para validação em execução se necessário e classifique quebras entre versões. Usar json-schema-validator, json-schema-to-zod-schema-converter, openapi-diff-breach-detector, api-breaking-changes-detector-migration-planner.
Valide respostas capturadas, compare payloads conhecidos e gere casos de limite ou mutação; não apresente isso como implantação ou monitoramento ao vivo. Usar api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester, api-mock-server.
Guia de fluxo de trabalho
Gere tipos e documentação a partir de OpenAPI ou um schema inicial de um exemplo; mantenha versão e casos na revisão.
Valide payloads normais e de erro, converta o schema para validação em execução se necessário e classifique quebras entre versões.
Valide respostas capturadas, compare payloads conhecidos e gere casos de limite ou mutação; não apresente isso como implantação ou monitoramento ao vivo.
Escolha A quando o contrato já existir e precisar gerar documentação e tipos. Escolha B quando só houver payloads, revisando o schema inferido antes de adotá-lo.