codegen

package

Go to main page

Versions in this module

v3

v3.72.8

Feb 24, 2026

v3.72.7

Feb 22, 2026

v3.72.6

Feb 21, 2026

v3.72.5

Feb 21, 2026

v3.72.4

Feb 21, 2026

v3.72.3

Feb 20, 2026

v3.72.2

Feb 20, 2026

Changes in this version

type Output

+ SkipFmt bool

v3.72.1

Feb 19, 2026

v3.72.0

Feb 19, 2026

Changes in this version

+ var ErrServerRequiresService = errors.New(...)

type HandlerOptions

+ Service *ServiceOptions

+ type ServiceOptions struct

v3.71.4

Feb 18, 2026

v3.71.3

Feb 17, 2026

v3.71.2

Feb 17, 2026

Changes in this version

type ParseContext

+ func CreateParseContextFromModel(model *v3high.Document, cfg Configuration) (*ParseContext, error)

v3.71.1

Feb 16, 2026

v3.71.0

Feb 15, 2026

Changes in this version

type HandlerOptions

+ MultipartMaxMemory int

type TypeDefinition

+ func (t TypeDefinition) GetErrorConstructor(errTypes map[string]string, typeSchemaMap map[string]GoSchema) string

v3.70.0

Feb 13, 2026

Changes in this version

type GenerateOptions

+ MCPServer *MCPServerOptions

+ type MCPExtension struct

+ Description string

+ Name string

+ Skip *bool

+ func (e *MCPExtension) ShouldSkip(defaultSkip bool) bool

+ type MCPServerOptions struct

+ DefaultSkip bool

type OperationDefinition

+ MCP *MCPExtension

v3.69.0

Feb 11, 2026

v3.68.0

Feb 11, 2026

Changes in this version

type Configuration

+ Overlay *OverlayOptions

+ type OverlayOptions struct

+ Sources []string

v3.67.0

Feb 11, 2026

Changes in this version

+ var ErrHandlerKindRequired = errors.New("handler kind is required")

+ var ErrHandlerKindUnsupported = errors.New("unsupported handler kind")

+ var ErrServerHandlerPackageRequired = errors.New("server handler-package is required when server generation is enabled")

+ func IsScaffoldFile(name string) bool

+ func ScaffoldFileName(name string) string

type GenerateOptions

+ Handler *HandlerOptions

+ Models *bool

type GoSchema

+ func (s GoSchema) Format() string

+ type HandlerKind string

+ const HandlerKindBeego

+ const HandlerKindChi

+ const HandlerKindEcho

+ const HandlerKindFastHTTP

+ const HandlerKindFiber

+ const HandlerKindGin

+ const HandlerKindGoFrame

+ const HandlerKindGoZero

+ const HandlerKindGorillaMux

+ const HandlerKindHertz

+ const HandlerKindIris

+ const HandlerKindKratos

+ const HandlerKindStdHTTP

+ func (k HandlerKind) IsValid() bool

+ type HandlerOptions struct

+ Kind HandlerKind

+ Middleware *MiddlewareOptions

+ ModelsPackageAlias string

+ Name string

+ Output *ScaffoldOutput

+ Server *ServerOptions

+ Validation HandlerValidation

+ func (o HandlerOptions) ResolveScaffoldOutput(rootOutput *Output) ScaffoldOutput

+ func (o HandlerOptions) ResolveServerOutput() ScaffoldOutput

+ func (o HandlerOptions) Validate() error

+ type HandlerValidation struct

+ Request bool

+ Response bool

+ type MiddlewareOptions struct

type ParameterDefinition

+ func (pd ParameterDefinition) IsPointerType() bool

type Property

+ func (p Property) GoVariableName() string

+ func (p Property) IsFile() bool

type ResponseContentDefinition

+ IsRaw bool

+ type ScaffoldOutput struct

+ Directory string

+ Overwrite bool

+ Package string

+ type ServerOptions struct

+ Directory string

+ HandlerPackage string

+ Port int

+ Timeout int

+ func (o ServerOptions) Validate() error

+ func (o ServerOptions) WithDefaults() ServerOptions

type TplOperationsContext

+ PackageName string

+ ServerOptions *ServerOptions

type TplTypeContext

+ TypeTracker *TypeTracker

type TypeTracker

+ func (r *TypeTracker) MarkNeedsErrorMethod(name string)

+ func (r *TypeTracker) NeedsErrorMethod(name string) bool

v3.66.3

Feb 7, 2026

v3.66.2

Jan 31, 2026

v3.66.2-dev1

Jan 30, 2026

v3.66.1

Jan 30, 2026

Changes in this version

type GoSchema

+ func (s GoSchema) TypeDeclWithNullable() string

v3.66.0

Jan 29, 2026

v3.65.0

Jan 20, 2026

Changes in this version

type EnumDefinition

+ SpecLocation SpecLocation

v3.64.0

Jan 18, 2026

Changes in this version

type EnumContext

+ TypeTracker *TypeTracker

type EnumDefinition

+ Values []EnumValue

+ type EnumValue struct

+ Name string

+ Value string

type GoSchema

+ IsUnionWrapper bool

type ParseContext

+ TypeTracker *TypeTracker

type ParseOptions

+ ErrorMapping map[string]string

+ type TypeTracker struct

+ func (r *TypeTracker) AsMap() map[string]*TypeDefinition

+ func (r *TypeTracker) Exists(name string) bool

+ func (r *TypeTracker) LookupByName(name string) (*TypeDefinition, bool)

+ func (r *TypeTracker) LookupByRef(ref string) (string, bool)

+ func (r *TypeTracker) Size() int

v3.63.5

Jan 12, 2026

Changes in this version

+ var ErrAmbiguousDiscriminatorMapping = errors.New("ambiguous discriminator.mapping: please replace inlined object with $ref")

+ var ErrDiscriminatorNotAllMapped = errors.New("discriminator: not all schemas were mapped")

+ var ErrEmptyReferencePath = errors.New("empty reference path")

+ var ErrEmptySchema = errors.New("empty schema")

+ var ErrMergingSchemasWithAdditionalProperties = errors.New("merging two schemas with additional properties, this is unhandled")

+ var ErrMergingSchemasWithDifferentDefaults = errors.New("merging two sets of defaults is undefined")

+ var ErrMergingSchemasWithDifferentDiscriminators = errors.New("merging two schemas with discriminators is not supported")

+ var ErrMergingSchemasWithDifferentExclusiveMax = errors.New("merging two schemas with different ExclusiveMax")

+ var ErrMergingSchemasWithDifferentExclusiveMin = errors.New("merging two schemas with different ExclusiveMin")

+ var ErrMergingSchemasWithDifferentFormats = errors.New("can not merge incompatible formats")

+ var ErrMergingSchemasWithDifferentNullable = errors.New("merging two schemas with different Nullable")

+ var ErrMergingSchemasWithDifferentReadOnly = errors.New("merging two schemas with different ReadOnly")

+ var ErrMergingSchemasWithDifferentUniqueItems = errors.New("merging two schemas with different UniqueItems")

+ var ErrMergingSchemasWithDifferentWriteOnly = errors.New("merging two schemas with different WriteOnly")

+ var ErrOperationNameEmpty = errors.New("operation name cannot be an empty string")

+ var ErrRequestPathEmpty = errors.New("request path cannot be an empty string")

+ var ErrTransitiveMergingAllOfSchema1 = errors.New("error transitive merging AllOf on schema 1")

+ var ErrTransitiveMergingAllOfSchema2 = errors.New("error transitive merging AllOf on schema 2")

+ var TemplateFunctions = template.FuncMap

+ func CreateDocument(docContents []byte, cfg Configuration) (libopenapi.Document, error)

+ func FormatCode(src string) (string, error)

+ func LoadDocumentFromContents(contents []byte) (libopenapi.Document, error)

+ func UppercaseFirstCharacter(str string) string

+ type AdditionalImport struct

+ Alias string

+ Package string

+ type Client struct

+ Name string

+ Timeout time.Duration

+ type Configuration struct

+ AdditionalImports []AdditionalImport

+ Client *Client

+ CopyrightHeader string

+ ErrorMapping map[string]string

+ Filter FilterConfig

+ Generate *GenerateOptions

+ Output *Output

+ PackageName string

+ SkipPrune bool

+ UserContext map[string]any

+ UserTemplates map[string]string

+ func NewDefaultConfiguration() Configuration

+ func (o Configuration) Merge(other Configuration) Configuration

+ func (o Configuration) OverwriteWith(other Configuration) Configuration

+ func (o Configuration) WithDefaults() Configuration

+ type Constraints struct

+ Max *float64

+ MaxItems *int64

+ MaxLength *int64

+ MaxProperties *int64

+ Min *float64

+ MinItems *int64

+ MinLength *int64

+ MinProperties *int64

+ Nullable *bool

+ Pattern *string

+ ReadOnly *bool

+ Required *bool

+ ValidationTags []string

+ WriteOnly *bool

+ func (c Constraints) Count() int

+ func (c Constraints) IsEqual(other Constraints) bool

+ type ConstraintsContext struct

+ type Discriminator struct

+ Mapping map[string]string

+ Property string

+ func (d *Discriminator) JSONTag() string

+ func (d *Discriminator) PropertyName() string

+ type EnumContext struct

+ Config Configuration

+ Enums []EnumDefinition

+ Imports []string

+ TypeRegistry TypeRegistry

+ WithHeader bool

+ type EnumDefinition struct

+ Name string

+ PrefixTypeName bool

+ Schema GoSchema

+ ValueWrapper string

+ func (e *EnumDefinition) GetValues() map[string]string

+ type FieldDescriptor struct

+ GoName string

+ GoType string

+ IsRef bool

+ JsonName string

+ Required bool

+ type FilterConfig struct

+ Exclude FilterParamsConfig

+ Include FilterParamsConfig

+ func (o FilterConfig) IsEmpty() bool

+ type FilterParamsConfig struct

+ Extensions []string

+ OperationIDs []string

+ Paths []string

+ SchemaProperties map[string][]string

+ Tags []string

+ func (o FilterParamsConfig) IsEmpty() bool

+ type GenerateOptions struct

+ AlwaysPrefixEnumValues bool

+ Client bool

+ DefaultIntType string

+ OmitDescription bool

+ Validation ValidationOptions

+ type GeneratedCode map[string]string

+ func Generate(docContents []byte, cfg Configuration) (GeneratedCode, error)

+ func (g GeneratedCode) GetCombined() string

+ type GoSchema struct

+ AdditionalPropertiesType *GoSchema

+ AdditionalTypes []TypeDefinition

+ ArrayType *GoSchema

+ Constraints Constraints

+ DefineViaAlias bool

+ Description string

+ Discriminator *Discriminator

+ EnumValues map[string]string

+ GoType string

+ HasAdditionalProperties bool

+ IsPrimitiveAlias bool

+ OpenAPISchema *base.Schema

+ Properties []Property

+ RefType string

+ SkipOptionalPointer bool

+ UnionElements []UnionElement

+ func GenerateGoSchema(schemaProxy *base.SchemaProxy, options ParseOptions) (GoSchema, error)

+ func (s GoSchema) ContainsUnions() bool

+ func (s GoSchema) GetAdditionalTypeDefs() []TypeDefinition

+ func (s GoSchema) IsAnyType() bool

+ func (s GoSchema) IsExternalRef() bool

+ func (s GoSchema) IsRef() bool

+ func (s GoSchema) IsZero() bool

+ func (s GoSchema) NeedsValidation() bool

+ func (s GoSchema) TypeDecl() string

+ func (s GoSchema) ValidateDecl(alias string, validatorVar string) string

+ func (s GoSchema) ValidateDeclWithOptions(alias string, validatorVar string, forceSimple bool) string

+ type OperationDefinition struct

+ Body *RequestBodyDefinition

+ BodyRequired bool

+ Description string

+ Header *TypeDefinition

+ ID string

+ Method string

+ Path string

+ PathParams *TypeDefinition

+ Query *RequestParametersDefinition

+ Response ResponseDefinition

+ Summary string

+ TypeDefinitions []TypeDefinition

+ func (o OperationDefinition) GetSuccessResponse() string

+ func (o OperationDefinition) HasRequestOptions() bool

+ func (o OperationDefinition) RequiresParamObject() bool

+ func (o OperationDefinition) SummaryAsComment() string

+ type Output struct

+ Directory string

+ Filename string

+ UseSingleFile bool

+ type ParameterDefinition struct

+ In string

+ ParamName string

+ Required bool

+ Schema GoSchema

+ Spec *v3high.Parameter

+ func (pd ParameterDefinition) Explode() bool

+ func (pd ParameterDefinition) GoName() string

+ func (pd ParameterDefinition) GoVariableName() string

+ func (pd ParameterDefinition) IndirectOptional() bool

+ func (pd ParameterDefinition) IsJson() bool

+ func (pd ParameterDefinition) IsPassThrough() bool

+ func (pd ParameterDefinition) IsStyled() bool

+ func (pd ParameterDefinition) TypeDef() string

+ type ParameterDefinitions []ParameterDefinition

+ func (p ParameterDefinitions) FindByName(name string) *ParameterDefinition

+ type ParameterEncoding struct

+ AllowReserved bool

+ Explode *bool

+ Required bool

+ Style string

+ type ParseContext struct

+ Enums []EnumDefinition

+ Imports []string

+ Operations []OperationDefinition

+ ResponseErrors []string

+ TypeDefinitions map[SpecLocation][]TypeDefinition

+ TypeRegistry TypeRegistry

+ UnionTypes []TypeDefinition

+ func CreateParseContext(docContents []byte, cfg Configuration) (*ParseContext, []error)

+ func CreateParseContextFromDocument(doc libopenapi.Document, cfg Configuration) (*ParseContext, error)

+ type ParseOptions struct

+ AlwaysPrefixEnumValues bool

+ DefaultIntType string

+ OmitDescription bool

+ SkipValidation bool

+ func (o ParseOptions) AddType(td TypeDefinition) ParseOptions

+ func (o ParseOptions) WithBaseName(baseName string) ParseOptions

+ func (o ParseOptions) WithCurrentTypes(currentTypes map[string]TypeDefinition) ParseOptions

+ func (o ParseOptions) WithModel(model *v3high.Document) ParseOptions

+ func (o ParseOptions) WithNameSuffixes(suffixes []string) ParseOptions

+ func (o ParseOptions) WithPath(path []string) ParseOptions

+ func (o ParseOptions) WithReference(reference string) ParseOptions

+ func (o ParseOptions) WithSpecLocation(specLocation SpecLocation) ParseOptions

+ type Parser struct

+ func NewParser(cfg Configuration, ctx *ParseContext) (*Parser, error)

+ func (p *Parser) Parse() (GeneratedCode, error)

+ func (p *Parser) ParseTemplates(templates []string, data any) (string, error)

+ type Property struct

+ Constraints Constraints

+ Deprecated bool

+ Description string

+ Extensions map[string]any

+ GoName string

+ JsonFieldName string

+ ParentType string

+ Schema GoSchema

+ SensitiveData *runtime.SensitiveDataConfig

+ func (p Property) GoTypeDef() string

+ func (p Property) IsEqual(other Property) bool

+ func (p Property) IsPointerType() bool

+ type RequestBodyDefinition struct

+ ContentType string

+ Default bool

+ Encoding map[string]RequestBodyEncoding

+ Name string

+ NameTag string

+ Required bool

+ Schema GoSchema

+ func (r RequestBodyDefinition) IsOptional() bool

+ func (r RequestBodyDefinition) TypeDef(opID string) TypeDefinition

+ type RequestBodyEncoding struct

+ ContentType string

+ Explode *bool

+ Style string

+ type RequestParametersDefinition struct

+ Encoding map[string]ParameterEncoding

+ Name string

+ Params []ParameterDefinition

+ TypeDef TypeDefinition

+ type ResponseContentDefinition struct

+ ContentType string

+ Description string

+ Headers map[string]GoSchema

+ IsSuccess bool

+ NameTag string

+ Ref string

+ ResponseName string

+ Schema GoSchema

+ StatusCode int

+ type ResponseDefinition struct

+ All map[int]*ResponseContentDefinition

+ Error *ResponseContentDefinition

+ Success *ResponseContentDefinition

+ SuccessStatusCode int

+ type SchemaDescriptor struct

+ AdditionalPropertiesType string

+ Fields []FieldDescriptor

+ HasAdditionalProperties bool

+ type SpecLocation string

+ const SpecLocationBody

+ const SpecLocationHeader

+ const SpecLocationPath

+ const SpecLocationQuery

+ const SpecLocationResponse

+ const SpecLocationSchema

+ const SpecLocationUnion

+ type TplOperationsContext struct

+ Config Configuration

+ Imports []string

+ Operations []OperationDefinition

+ WithHeader bool

+ type TplTypeContext struct

+ Config Configuration

+ Imports []string

+ ResponseErrors map[string]bool

+ SpecLocation string

+ TypeSchemaMap map[string]GoSchema

+ Types []TypeDefinition

+ WithHeader bool

+ type TypeDefinition struct

+ HasSensitiveData bool

+ JsonName string

+ Name string

+ NeedsMarshaler bool

+ Schema GoSchema

+ SpecLocation SpecLocation

+ func (t TypeDefinition) GetErrorResponse(errTypes map[string]string, alias string, typeSchemaMap map[string]GoSchema) string

+ func (t TypeDefinition) IsAlias() bool

+ func (t TypeDefinition) IsOptional() bool

+ type TypeRegistry map[string]int

+ func (tr TypeRegistry) GetName(name string) string

+ type UnionElement struct

+ Schema GoSchema

+ TypeName string

+ func (u UnionElement) Method() string

+ func (u UnionElement) String() string

+ type ValidationOptions struct

+ Response bool

+ Simple bool

+ Skip bool

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