Describe the contract
Use JSON Schema as the shared, machine-readable source for your interface.
JSON Schema specification toolkit
Write the specification once. Generate the rest.
Spec Toolkit turns a JSON Schema contract into clear documentation, consumable schemas, and typed interfaces that stay in sync.
Currently in draft, not yet recommended for production use.
book.schema.yamlSOURCE
spec-toolkit
DocumentationReadable Markdown
TypesTypeScript interfaces
SchemasReady-to-use JSON
One dependable source
Keep every representation aligned
Less duplicated writing, fewer contradictions, and faster feedback for specification authors and adopters.
Add context
Keep introductions, examples, and optional extensions close to the schema.
Generate consistent outputs
Produce synchronized documentation, schemas, and types from one command.
Start small
From schema to useful artifacts in one command.
npx @open-resource-discovery/spec-toolkit -c spec-toolkit.config.json