Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

codegen

package

Go to main page

Versions in this module

v3

v3.67.2

Feb 2, 2026

v3.67.1

Feb 2, 2026

v3.67.0

Feb 2, 2026

v3.66.2

Feb 2, 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

+ TypeTracker *TypeTracker

+ WithHeader bool

+ type EnumDefinition struct

+ Name string

+ PrefixTypeName bool

+ Schema GoSchema

+ SpecLocation SpecLocation

+ ValueWrapper string

+ Values []EnumValue

+ type EnumValue struct

+ Name string

+ Value 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

+ AutoExtraTags map[string]string

+ 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

+ IsUnionWrapper 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) TypeDeclWithNullable() 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

+ TypeTracker *TypeTracker

+ UnionTypes []TypeDefinition

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

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

+ type ParseOptions struct

+ AlwaysPrefixEnumValues bool

+ AutoExtraTags map[string]string

+ DefaultIntType string

+ ErrorMapping map[string]string

+ OmitDescription bool

+ SkipValidation bool

+ 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 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

+ 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