Voxgig SDK Generator

Toolchain documentation

The toolchain is a pipeline of separately published packages. This section documents each of them, with every example taken from a public SDK the toolchain generated.

Facts and version numbers checked against the source repositories. Each page links the first-party documentation it summarises; where they disagree with a page here, they are the authority.

The pipeline#

A spec goes in one end and SDKs come out the other. Knowing which stage you are in is what tells you where to fix something.

StageDone byProduces
Describeyour OpenAPI 3 or Swagger 2 specthe API as its authors wrote it, paths and schemas
Modelapidefentities, operations, fields and flows, with the guide that records why
Shapeyou, editing the modelthe SDK surface you actually want: names, types, which operations exist
Generatesdkgenone SDK per target language, plus a CLI, an MCP server and generated docs
Verifythe generated offline suitestests that run with no server and no credentials

The split matters when something is wrong. If the SDK exposes the wrong shape, the fix is in the model, and usually in apidef's guide. If the shape is right and the code is wrong, the fix is in a template or a component. Generated target code is never the place to fix either, because regeneration overwrites it.

The components#

Each is a separately published package with its own repository and its own release cycle. A sibling arriving later is a package, not a change to the generator.

sdkgen

Turns the model into SDKs. The generator. It reads the model apidef produced and writes one idiomatic SDK per target language, each with the same operation pipeline, the same feature set, generated documentation and an offline test suite.

Read the sdkgen documentation

apidef

Turns a spec into a model. The front half. It reads an OpenAPI 3 or Swagger 2 spec and produces an internal model of entities, operations, fields and flows, inferring what the spec leaves implicit and recording why it decided each thing.

Read the apidef documentation

create-sdkgen

Scaffolds a project. The way in. One command turns an OpenAPI spec into a project with the model already built, the targets you asked for already added, and a generate script wired up. Start here unless you are working on the toolchain itself.

Read the create-sdkgen documentation

docgen

Generates documentation targets. An sdkgen package rather than a separate tool. sdkgen defines a docs kind, a target whose destination is a documentation system rather than a language; docgen supplies the items for it.

Read the docgen documentation

apigen

Not yet published. A repository exists and nothing is published from it. It is listed here so the shape of the toolchain is honest about what is real, and it will get a page when there is something to document.

apigen on GitHub

The two worked examples#

Every code sample in this section comes from one of these, so you can check it against the repository it came from rather than trusting it. They are picked to be complementary rather than redundant.

solardemo

  • Generated for the Solar System API.
  • Breadth. Two entities and a nested one, generated into every target the toolchain has, so it is the repository to read when the question is what a given language's output looks like.
  • Entities: Planet, Moon, nested under Planet.
  • Targets: every bundled target, plus the CLI, the MCP server, the data package and the Seneca provider.
  • Features: secrets, test.

elementdemo

  • Generated for the Periodic Table API.
  • Depth. Four entities, a server URL templated on a variable, five features including one this project wrote itself, and five targets. It is the repository to read when the question is how far the model can be pushed.
  • Entities: Element, Group, Series, Isotope, nested under Element.
  • Targets: TypeScript, Python, Go, Java, Bash.
  • Features: elementcard, its own, retry, secrets, test, timeout.

Where to start#

  • Building an SDK for your own API: start at create-sdkgen.
  • Working out what the generator can produce: sdkgen.
  • The SDK has the wrong shape and you need to correct it: apidef.
  • Extending the toolchain rather than using it: docgen, the worked example of a package.

Read the generated code#

The toolchain is MIT and open, and the catalog holds 600+ generated SDKs readable without installing anything.

SDK featuresGenerator comparisons

Get the Voxgig dispatch

Short notes on building SDKs, CLIs, REPLs, and MCPs for API-first teams, plus the occasional Fireside episode pick.

By signing up you agree to our Terms and Conditions.