SDK Guides

Configure TypeScript, Python, and Go SDK generation — package naming, registry credentials, versioning, and custom templates.

TypeScript / JavaScript

The TypeScript SDK generates a strongly-typed client with full JSDoc, using fetch as the base transport. Configuration in your project's SDK settings:

TypeScript SDK config

            typescript:
              package_name: @your-scope/api-sdk
              registry: npm
              module_format: esm+cjs # dual package
              target: es2020
          

Apistaq will publish to npm using your configured NPM_TOKEN secret.

Python

The Python SDK generates an async client using httpx with Pydantic models for request/response validation. Supports Python 3.9+.

Python SDK config

            python:
              package_name: your-company-api
              registry: pypi
              python_version: ">=3.9"
          

Go

The Go SDK generates an idiomatic Go client with context support and structured error types. Published as a Go module to pkg.go.dev via your configured module path.

Versioning

SDK versions are derived from your OpenAPI info.version field. Apistaq follows these rules:

Patch bump for non-breaking changes (new optional fields, new endpoints)
Minor bump for additive changes (new required fields on optional bodies)
Major bump for breaking changes (removed endpoints, renamed fields)

You can override auto-versioning and set a specific version in the SDK config. This is useful for synchronizing major versions across multiple SDKs simultaneously.