apisdkgen

README

apisdkgen - Go API SDK generator

Generate typed TypeScript, Kotlin, and Swift SDKs and an API reference from Go DTOs and route definitions.

Define an apispec.Config for your routes, then call apisdkgen.Generate from your application's generation command. Keep the specification in sync with the routes your server exposes. See the Go Reference for configuration and output options.

Documentation

Overview

Package apisdkgen generates typed client SDKs and API references. It supports TypeScript, Kotlin, and Swift from Go DTO types and route definitions.

SDK specifications are defined by each package in an exported SDKAPI() function returning an apispec.Config with that API's error-code type. The consumer's gen-api-sdk command registers those specs and chooses output paths.

Index

• func Generate(api *API) error
• type API
  • func NewAPI[C ~string](sourceDir string, output OutputConfig, config apispec.Config[C]) API
• type OutputConfig

Functions

func Generate

func Generate(api *API) error

Generate writes configured SDK outputs for one API surface.

Types

type API

type API struct {
	// contains filtered or unexported fields
}

API describes one API surface to generate.

func NewAPI

func NewAPI[C ~string](sourceDir string, output OutputConfig, config apispec.Config[C]) API

NewAPI constructs an SDK generation target from a typed API specification.

type OutputConfig

type OutputConfig struct {
	TypeScriptDir string
	KotlinDir     string
	SwiftDir      string
	MarkdownDir   string
}

OutputConfig names the generated output directories for each target.