sparktype ⚡Type-safe OpenAPI

Generate static type definitions from OpenAPI specifications for TypeScript, Python, and Go.

Get Started

View on GitHub

📦

Multiple Formats

Output schemas as TypeScript interfaces, Zod schemas, Python TypedDicts, or Go structs from a single source of truth.

🔋

CI-Friendly

Detect drift between your OpenAPI specs and generated types with the check command. Perfect for CI/CD pipelines.

🔍

Filtering & Organizing

Include or exclude schemas by glob patterns. Organize output with namespaces to keep your types clean and maintainable.

🌐

Cross-Platform

Available via npm, pip, Homebrew, or direct binary download. Works on macOS, Linux, and Windows.

Quick Start

Install sparktype using your preferred package manager:

npmpipHomebrewGo

npm install -D sparktype

pip install sparktype

brew install hntrl/tap/sparktype

go install github.com/hntrl/sparktype/cmd/sparktype@latest

Create a typegen.jsonc configuration file:

jsonc

{
  "$schema": "https://hntrl.github.io/sparktype/schema.json",
  "specs": {
    "api": {
      "path": "./openapi.yaml"
    }
  },
  "outputs": [
    {
      "path": "./src/types/api.ts",
      "format": "typescript",
      "contents": ["api:*"]
    }
  ]
}

Generate your types:

CLIpackage.jsonMakefilego:generate

sparktype generate

json

{
  "scripts": {
    "types": "sparktype generate",
    "types:check": "sparktype check"
  }
}

makefile

.PHONY: types
types:
	sparktype generate

.PHONY: types-check
types-check:
	sparktype check

//go:generate sparktype generate
package main

That's it! Your types are now generated and ready to use. See the Getting Started guide for a complete walkthrough.