A) Start with OpenAPI or B) start with a JSON sample?
Choose A when the contract already exists and should produce docs and types. Choose B when payloads are the only source, then review the inferred schema before adopting it.
Elysia Tools
Navigation
Workflow Playbook
Define an API contract, validate schemas and captured payloads, detect compatibility risks, and record test acceptance.
Hubs
Define an API contract, validate schemas and captured payloads, detect compatibility risks, and record test acceptance.
Use this guide to turn the stated scope into a reviewable result. Keep the source, intermediate outputs, and decisions together so the next person can understand what was checked and why.
Prepare an OpenAPI or JSON Schema source, or a representative JSON payload.
Set the compatibility policy, required fields, fixtures, and acceptance thresholds.
Decision: A) Start with OpenAPI or B) start with a JSON sample?. Choose A when the contract already exists and should produce docs and types. Choose B when payloads are the only source, then review the inferred schema before adopting it.
Generate types and documentation from OpenAPI, or draft a JSON Schema from a sample; keep the source version and fixtures together. Use openapi-to-typescript-generator, api-doc-generator, json-schema-generator.
Check normal and error payloads, convert the schema for runtime validation when useful, and classify breaking changes between versions. Use json-schema-validator, json-schema-to-zod-schema-converter, openapi-diff-breach-detector, api-breaking-changes-detector-migration-planner.
Validate captured responses, compare known payloads, and generate boundary or mutation cases; record findings without implying deployment or live monitoring. Use api-response-contract-validator, api-response-diff-semantic-analyzer, api-contract-stress-tester, api-contract-mutation-tester, api-mock-server.
Workflow playbook
Generate types and documentation from OpenAPI, or draft a JSON Schema from a sample; keep the source version and fixtures together.
Check normal and error payloads, convert the schema for runtime validation when useful, and classify breaking changes between versions.
Validate captured responses, compare known payloads, and generate boundary or mutation cases; record findings without implying deployment or live monitoring.
Choose A when the contract already exists and should produce docs and types. Choose B when payloads are the only source, then review the inferred schema before adopting it.