generators

package
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 18, 2026 License: EUPL-1.2 Imports: 12 Imported by: 0

Documentation

Overview

Package generators provides SDK code generators for different languages.

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Generator

type Generator interface {
	// Language returns the generator's target language identifier.
	Language() string

	// Generate creates SDK from OpenAPI spec.
	Generate(ctx context.Context, opts Options) core.Result

	// Available checks if generator dependencies are installed.
	Available() bool

	// Install returns instructions for installing the generator.
	Install() string
}

Generator defines the interface for SDK generators.

gen := generators.NewTypeScriptGenerator() err := gen.Generate(ctx, opts)

type GoGenerator

type GoGenerator struct{}

GoGenerator generates Go SDKs from OpenAPI specs.

g := generators.NewGoGenerator()

func NewGoGenerator

func NewGoGenerator() *GoGenerator

NewGoGenerator creates a new Go generator.

g := generators.NewGoGenerator()

Example

--- v0.9.0 generated usage examples ---

_ = NewGoGenerator()
core.Println("NewGoGenerator")
Output:
NewGoGenerator

func (*GoGenerator) Available

func (g *GoGenerator) Available() bool

Available checks if generator dependencies are installed.

if g.Available() { err = g.Generate(ctx, opts) }

Example
subject := &GoGenerator{}
_ = subject.Available()
core.Println("GoGenerator_Available")
Output:
GoGenerator_Available

func (*GoGenerator) Generate

func (g *GoGenerator) Generate(ctx context.Context, opts Options) core.Result

Generate creates SDK from OpenAPI spec.

err := g.Generate(ctx, generators.Options{SpecPath: "docs/openapi.yaml", OutputDir: "sdk/go"})

Example
ctx, cancel := core.WithCancel(core.Background())
cancel()
subject := &GoGenerator{}
_ = subject.Generate(ctx, Options{})
core.Println("GoGenerator_Generate")
Output:
GoGenerator_Generate

func (*GoGenerator) Install

func (g *GoGenerator) Install() string

Install returns instructions for installing the generator.

fmt.Println(g.Install()) // → "go install github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen@latest"

Example
subject := &GoGenerator{}
_ = subject.Install()
core.Println("GoGenerator_Install")
Output:
GoGenerator_Install

func (*GoGenerator) Language

func (g *GoGenerator) Language() string

Language returns the generator's target language identifier.

lang := g.Language() // → "go"

Example
subject := &GoGenerator{}
_ = subject.Language()
core.Println("GoGenerator_Language")
Output:
GoGenerator_Language

type Options

type Options struct {
	// SpecPath is the path to the OpenAPI spec file.
	SpecPath string
	// OutputDir is where to write the generated SDK.
	OutputDir string
	// PackageName is the package/module name.
	PackageName string
	// Version is the SDK version.
	Version string
}

Options holds common generation options.

opts := generators.Options{SpecPath: "docs/openapi.yaml", OutputDir: "sdk/typescript", PackageName: "@host-uk/api-client", Version: "1.0.0"}

type PHPGenerator

type PHPGenerator struct{}

PHPGenerator generates PHP SDKs from OpenAPI specs.

g := generators.NewPHPGenerator()

func NewPHPGenerator

func NewPHPGenerator() *PHPGenerator

NewPHPGenerator creates a new PHP generator.

g := generators.NewPHPGenerator()

Example

--- v0.9.0 generated usage examples ---

_ = NewPHPGenerator()
core.Println("NewPHPGenerator")
Output:
NewPHPGenerator

func (*PHPGenerator) Available

func (g *PHPGenerator) Available() bool

Available checks if generator dependencies are installed (requires Docker).

if g.Available() { err = g.Generate(ctx, opts) }

Example
subject := &PHPGenerator{}
_ = subject.Available()
core.Println("PHPGenerator_Available")
Output:
PHPGenerator_Available

func (*PHPGenerator) Generate

func (g *PHPGenerator) Generate(ctx context.Context, opts Options) core.Result

Generate creates SDK from OpenAPI spec (requires Docker).

err := g.Generate(ctx, generators.Options{SpecPath: "docs/openapi.yaml", OutputDir: "sdk/php"})

Example
ctx, cancel := core.WithCancel(core.Background())
cancel()
subject := &PHPGenerator{}
_ = subject.Generate(ctx, Options{})
core.Println("PHPGenerator_Generate")
Output:
PHPGenerator_Generate

func (*PHPGenerator) Install

func (g *PHPGenerator) Install() string

Install returns instructions for installing the generator.

fmt.Println(g.Install()) // → "Docker is required for PHP SDK generation"

Example
subject := &PHPGenerator{}
_ = subject.Install()
core.Println("PHPGenerator_Install")
Output:
PHPGenerator_Install

func (*PHPGenerator) Language

func (g *PHPGenerator) Language() string

Language returns the generator's target language identifier.

lang := g.Language() // → "php"

Example
subject := &PHPGenerator{}
_ = subject.Language()
core.Println("PHPGenerator_Language")
Output:
PHPGenerator_Language

type PythonGenerator

type PythonGenerator struct{}

PythonGenerator generates Python SDKs from OpenAPI specs.

g := generators.NewPythonGenerator()

func NewPythonGenerator

func NewPythonGenerator() *PythonGenerator

NewPythonGenerator creates a new Python generator.

g := generators.NewPythonGenerator()

Example

--- v0.9.0 generated usage examples ---

_ = NewPythonGenerator()
core.Println("NewPythonGenerator")
Output:
NewPythonGenerator

func (*PythonGenerator) Available

func (g *PythonGenerator) Available() bool

Available checks if generator dependencies are installed.

if g.Available() { err = g.Generate(ctx, opts) }

Example
subject := &PythonGenerator{}
_ = subject.Available()
core.Println("PythonGenerator_Available")
Output:
PythonGenerator_Available

func (*PythonGenerator) Generate

func (g *PythonGenerator) Generate(ctx context.Context, opts Options) core.Result

Generate creates SDK from OpenAPI spec.

err := g.Generate(ctx, generators.Options{SpecPath: "docs/openapi.yaml", OutputDir: "sdk/python"})

Example
ctx, cancel := core.WithCancel(core.Background())
cancel()
subject := &PythonGenerator{}
_ = subject.Generate(ctx, Options{})
core.Println("PythonGenerator_Generate")
Output:
PythonGenerator_Generate

func (*PythonGenerator) Install

func (g *PythonGenerator) Install() string

Install returns instructions for installing the generator.

fmt.Println(g.Install()) // → "pip install openapi-python-client"

Example
subject := &PythonGenerator{}
_ = subject.Install()
core.Println("PythonGenerator_Install")
Output:
PythonGenerator_Install

func (*PythonGenerator) Language

func (g *PythonGenerator) Language() string

Language returns the generator's target language identifier.

lang := g.Language() // → "python"

Example
subject := &PythonGenerator{}
_ = subject.Language()
core.Println("PythonGenerator_Language")
Output:
PythonGenerator_Language

type Registry

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

Registry holds available generators.

r := generators.NewRegistry()

func NewRegistry

func NewRegistry() *Registry

NewRegistry creates a registry with all available generators.

r := generators.NewRegistry()

Example

--- v0.9.0 generated usage examples ---

_ = NewRegistry()
core.Println("NewRegistry")
Output:
NewRegistry

func (*Registry) Get

func (r *Registry) Get(lang string) (Generator, bool)

Get returns a generator by language.

gen, ok := r.Get("typescript")

Example
subject := NewRegistry()
_, _ = subject.Get("go")
core.Println("Registry_Get")
Output:
Registry_Get

func (*Registry) Languages

func (r *Registry) Languages() []string

Languages returns all registered language identifiers.

langs := r.Languages() // → ["go", "php", "python", "typescript"]

Example
subject := NewRegistry()
_ = subject.Languages()
core.Println("Registry_Languages")
Output:
Registry_Languages

func (*Registry) LanguagesIter

func (r *Registry) LanguagesIter() iter.Seq[string]

LanguagesIter returns an iterator for all registered language identifiers.

for lang := range r.LanguagesIter() { fmt.Println(lang) }

Example
subject := NewRegistry()
_ = subject.LanguagesIter()
core.Println("Registry_LanguagesIter")
Output:
Registry_LanguagesIter

func (*Registry) Register

func (r *Registry) Register(g Generator)

Register adds a generator to the registry.

r.Register(generators.NewTypeScriptGenerator())

Example
subject := NewRegistry()
subject.Register(NewGoGenerator())
core.Println("Registry_Register")
Output:
Registry_Register

type TypeScriptGenerator

type TypeScriptGenerator struct{}

TypeScriptGenerator generates TypeScript SDKs from OpenAPI specs.

g := generators.NewTypeScriptGenerator()

func NewTypeScriptGenerator

func NewTypeScriptGenerator() *TypeScriptGenerator

NewTypeScriptGenerator creates a new TypeScript generator.

g := generators.NewTypeScriptGenerator()

Example

--- v0.9.0 generated usage examples ---

_ = NewTypeScriptGenerator()
core.Println("NewTypeScriptGenerator")
Output:
NewTypeScriptGenerator

func (*TypeScriptGenerator) Available

func (g *TypeScriptGenerator) Available() bool

Available checks if generator dependencies are installed.

if g.Available() { err = g.Generate(ctx, opts) }

Example
subject := &TypeScriptGenerator{}
_ = subject.Available()
core.Println("TypeScriptGenerator_Available")
Output:
TypeScriptGenerator_Available

func (*TypeScriptGenerator) Generate

func (g *TypeScriptGenerator) Generate(ctx context.Context, opts Options) core.Result

Generate creates SDK from OpenAPI spec.

err := g.Generate(ctx, generators.Options{SpecPath: "docs/openapi.yaml", OutputDir: "sdk/typescript"})

Example
ctx, cancel := core.WithCancel(core.Background())
cancel()
subject := &TypeScriptGenerator{}
_ = subject.Generate(ctx, Options{})
core.Println("TypeScriptGenerator_Generate")
Output:
TypeScriptGenerator_Generate

func (*TypeScriptGenerator) Install

func (g *TypeScriptGenerator) Install() string

Install returns instructions for installing the generator.

fmt.Println(g.Install()) // → "npm install -g openapi-typescript-codegen"

Example
subject := &TypeScriptGenerator{}
_ = subject.Install()
core.Println("TypeScriptGenerator_Install")
Output:
TypeScriptGenerator_Install

func (*TypeScriptGenerator) Language

func (g *TypeScriptGenerator) Language() string

Language returns the generator's target language identifier.

lang := g.Language() // → "typescript"

Example
subject := &TypeScriptGenerator{}
_ = subject.Language()
core.Println("TypeScriptGenerator_Language")
Output:
TypeScriptGenerator_Language

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL