openapi

package
v0.0.0-...-cafbd60 Latest Latest
Warning

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

Go to latest
Published: Dec 12, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source
const (
	// DefaultOutputFileName is the default output file name for the generated openapi functions.
	DefaultOutputFileName = "zz_generated.openapi.go"
)

Variables

View Source
var (
	// DefaultOutputPackagePath is the default output package path for the generated openapi functions.
	DefaultOutputPackagePath = filepath.Join("openapi", "generated_openapi")
)

Functions

func NewGenerator

func NewGenerator(opts Options) generation.MultiGroupGenerator

NewGenerator builds a new openapi generator.

Types

type Options

type Options struct {
	// HeaderFilePath is the path to the file containing the boilerplate header text.
	// When omitted, no header is added to the generated files.
	HeaderFilePath string

	// OutputFileName is the name of the output file.
	// When omitted, DefaultOutputFileName is used.
	// The current value of DefaultOutputFileName is "zz_generated.openapi.go".
	OutputFileName string

	// OutputPackagePath is the package path where the generated golang files will be written.
	OutputPackagePath string

	// Verify determines whether the generator should verify the content instead
	// of updating the generated file.
	Verify bool

	// GlobalParser is the parser for the global package.
	// This loads all packages found in the base directory.
	GlobalParser *parser.Parser

	// Universe is the universe for the global package.
	Universe types.Universe
}

Options contains the configuration required for the compatibility generator.

Jump to

Keyboard shortcuts

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