codegen

Aug 29, 2023

Changes in this version

+ func GenerateIrisServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func SetGlobalStateSpec(spec *openapi3.T)

+ func SwaggerUriToIrisUri(uri string) string

type CompatibilityOptions

+ CircularReferenceLimit int

type Configuration

+ NoVCSVersionOverride *string

type GenerateOptions

+ IrisServer bool

type ParameterDefinition

+ func CombineOperationParameters(globalParams []ParameterDefinition, localParams []ParameterDefinition) ([]ParameterDefinition, error)

type ResponseDefinition

+ func (r ResponseDefinition) IsExternalRef() bool

Aug 3, 2023

Changes in this version

type ResponseContentDefinition

+ func (r ResponseContentDefinition) IsJSON() bool

Jul 31, 2023

Changes in this version

type RequestBodyDefinition

+ func (r RequestBodyDefinition) IsJSON() bool

Jun 2, 2023

Changes in this version

+ func DeprecationComment(reason string) string

+ func GenerateFiberServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func GenerateUnionAndAdditionalProopertiesBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error)

+ func GetUserTemplateText(inputData string) (template string, err error)

+ func RefPathToObjName(refPath string) string

+ func ToCamelCaseWithInitialism(str string) string

type CompatibilityOptions

+ ApplyGorillaMiddlewareFirstToLast bool

type GenerateOptions

+ FiberServer bool

type OutputOptions

+ InitialismOverrides bool

type Property

+ Deprecated bool

+ Extensions map[string]interface{}

Oct 29, 2022

Changes in this version

+ func TypeDefinitionsEquivalent(t1, t2 TypeDefinition) bool

Oct 27, 2022

Changes in this version

+ func GenerateGorillaServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func GenerateStrictResponses(t *template.Template, responses []ResponseDefinition) (string, error)

+ func GenerateStrictServer(t *template.Template, operations []OperationDefinition, opts Configuration) (string, error)

+ func GenerateUnionBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error)

+ func GetParametersImports(params map[string]*openapi3.ParameterRef) (map[string]goImport, error)

+ func GetRequestBodiesImports(bodies map[string]*openapi3.RequestBodyRef) (map[string]goImport, error)

+ func GetResponsesImports(responses map[string]*openapi3.ResponseRef) (map[string]goImport, error)

+ func GetSchemaImports(schemas map[string]*openapi3.SchemaRef, excludeSchemas []string) (map[string]goImport, error)

+ func GetTypeDefinitionsImports(swagger *openapi3.T, excludeSchemas []string) (map[string]goImport, error)

+ func GoSchemaImports(schemas ...*openapi3.SchemaRef) (map[string]goImport, error)

+ func MergeImports(dst, src map[string]goImport)

+ func OperationImports(ops []OperationDefinition) (map[string]goImport, error)

+ func OperationSchemaImports(s *Schema) (map[string]goImport, error)

+ func ParseGoImportExtension(v *openapi3.SchemaRef) (*goImport, error)

+ func SortedHeadersKeys(dict openapi3.Headers) []string

+ func StringWithTypeNameToGoComment(in, typeName string) string

+ func SwaggerUriToFiberUri(uri string) string

+ func SwaggerUriToGorillaUri(uri string) string

+ func UppercaseFirstCharacterWithPkgName(str string) string

+ type AdditionalImport struct

+ Alias string

+ Package string

type CompatibilityOptions

+ AlwaysPrefixEnumValues bool

+ ApplyChiMiddlewareFirstToLast bool

+ DisableFlattenAdditionalProperties bool

+ DisableRequiredReadOnlyAsPointer bool

type Configuration

+ AdditionalImports []AdditionalImport

+ type Discriminator struct

+ Mapping map[string]string

+ Property string

+ func (d *Discriminator) JSONTag() string

+ func (d *Discriminator) PropertyName() string

type EnumDefinition

+ PrefixTypeName bool

type GenerateOptions

+ GorillaServer bool

+ Strict bool

type OperationDefinition

+ Responses []ResponseDefinition

+ func (o OperationDefinition) HasMaskedRequestContentTypes() bool

type OutputOptions

+ ClientTypeName string

type RequestBodyDefinition

+ Encoding map[string]RequestBodyEncoding

+ func (r RequestBodyDefinition) IsFixedContentType() bool

+ func (r RequestBodyDefinition) IsSupported() bool

+ func (r RequestBodyDefinition) IsSupportedByClient() bool

+ type RequestBodyEncoding struct

+ ContentType string

+ Explode *bool

+ Style string

+ type ResponseContentDefinition struct

+ ContentType string

+ NameTag string

+ Schema Schema

+ func (r ResponseContentDefinition) HasFixedContentType() bool

+ func (r ResponseContentDefinition) IsSupported() bool

+ func (r ResponseContentDefinition) NameTagOrContentType() string

+ func (r ResponseContentDefinition) TypeDef(opID string, statusCode int) *TypeDefinition

+ type ResponseDefinition struct

+ Contents []ResponseContentDefinition

+ Description string

+ Headers []ResponseHeaderDefinition

+ Ref string

+ StatusCode string

+ func GenerateResponseDefinitions(operationID string, responses openapi3.Responses) ([]ResponseDefinition, error)

+ func (r ResponseDefinition) GoName() string

+ func (r ResponseDefinition) HasFixedStatusCode() bool

+ func (r ResponseDefinition) IsRef() bool

+ type ResponseHeaderDefinition struct

+ GoName string

+ Name string

+ Schema Schema

type Schema

+ Discriminator *Discriminator

+ UnionElements []UnionElement

+ type UnionElement string

+ func (u UnionElement) Method() string

+ func (u UnionElement) String() string

May 20, 2022

Changes in this version

+ type CompatibilityOptions struct

+ OldAliasing bool

+ OldEnumConflicts bool

+ OldMergeSchemas bool

+ type Configuration struct

+ Compatibility CompatibilityOptions

+ Generate GenerateOptions

+ ImportMapping map[string]string

+ OutputOptions OutputOptions

+ PackageName string

+ func (o Configuration) UpdateDefaults() Configuration

+ func (o Configuration) Validate() error

type EnumDefinition

+ Conflicts bool

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

+ type GenerateOptions struct

+ ChiServer bool

+ Client bool

+ EchoServer bool

+ EmbeddedSpec bool

+ GinServer bool

+ Models bool

+ type OutputOptions struct

+ ExcludeSchemas []string

+ ExcludeTags []string

+ IncludeTags []string

+ ResponseTypeSuffix string

+ SkipFmt bool

+ SkipPrune bool

+ UserTemplates map[string]string

type Property

+ NeedsFormTag bool

type Schema

+ DefineViaAlias bool

+ func (s *Schema) AddProperty(p Property) error

type TypeDefinition

+ func (t *TypeDefinition) IsAlias() bool

Apr 19, 2022

Changes in this version

type Property

+ ReadOnly bool

+ WriteOnly bool

Jan 21, 2022

Changes in this version

+ func LoadTemplates(src embed.FS, t *template.Template) error

Nov 2, 2021

Changes in this version

+ func GenerateGinServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func SwaggerUriToGinUri(uri string) string

type Options

+ GenerateGinServer bool

Oct 4, 2021

Changes in this version

+ func GenerateTemplates(templates []string, t *template.Template, ops interface{}) (string, error)

Jun 2, 2021

Changes in this version

type Schema

+ OAPISchema *openapi3.Schema

Apr 14, 2021

Changes in this version

+ func GenerateEnums(t *template.Template, types []TypeDefinition) (string, error)

type Constants

+ EnumDefinitions []EnumDefinition

+ type EnumDefinition struct

+ Schema Schema

+ TypeName string

+ ValueWrapper string

Apr 2, 2021

Changes in this version

type Property

+ ExtensionProps *openapi3.ExtensionProps

+ type ResponseTypeDefinition struct

+ ContentTypeName string

+ ResponseName string

type Schema

+ Description string

Mar 20, 2021

Changes in this version

+ func SortedSecurityRequirementKeys(sr openapi3.SecurityRequirement) []string

Mar 19, 2021

Changes in this version

+ func EscapePathElements(path string) string

Mar 18, 2021

Changes in this version

+ func IsGoTypeReference(ref string) bool

+ func IsWholeDocumentReference(ref string) bool

Jan 30, 2021

Changes in this version

+ func GenerateConstants(t *template.Template, ops []OperationDefinition) (string, error)

+ type Constants struct

+ SecuritySchemeProviderNames []string

type Options

+ AliasTypes bool

type Schema

+ ArrayType *Schema

type TypeDefinition

+ func (t *TypeDefinition) CanAlias() bool

Aug 19, 2020

Changes in this version

type Options

+ ExcludeSchemas []string

Jul 9, 2020

Changes in this version

+ func IsGoIdentity(str string) bool

+ func IsPredeclaredGoIdentifier(str string) bool

+ func IsValidGoIdentity(str string) bool

+ func SanitizeEnumNames(enumNames []string) map[string]string

+ func SanitizeGoIdentity(str string) string

type Options

+ ImportMapping map[string]string

type Property

+ Nullable bool

type Schema

+ EnumValues map[string]string

Apr 2, 2020

Changes in this version

type Options

+ SkipPrune bool

+ type RefWrapper struct

+ HasValue bool

+ Ref string

+ SourceRef interface{}

Feb 19, 2020

Changes in this version

type Options

+ UserTemplates map[string]string

Jan 15, 2020

Changes in this version

type Options

+ ExcludeTags []string

+ IncludeTags []string

Nov 15, 2019

Changes in this version

+ func SanitizeCode(goCode string) string

+ func StringToGoComment(in string) string

type Options

+ SkipFmt bool

type Property

+ Description string

type TypeDefinition

+ ResponseName string

Sep 3, 2019

Changes in this version

+ func GenerateChiServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func GenerateEchoServer(t *template.Template, operations []OperationDefinition) (string, error)

+ func SwaggerUriToChiUri(uri string) string

type Options

+ GenerateChiServer bool

+ GenerateEchoServer bool

Aug 19, 2019

Changes in this version

type OperationDefinition

+ SecurityDefinitions []SecurityDefinition

+ type SecurityDefinition struct

+ ProviderName string

+ Scopes []string

+ func DescribeSecurityDefinition(securityRequirements openapi3.SecurityRequirements) []SecurityDefinition

Jul 27, 2019

Changes in this version

+ func SchemaNameToTypeName(name string) string

Jul 17, 2019

Changes in this version

+ func GenerateBodyDefinitions(operationID string, bodyOrRef *openapi3.RequestBodyRef) ([]RequestBodyDefinition, []TypeDefinition, error)

type OperationDefinition

+ Bodies []RequestBodyDefinition

+ BodyRequired bool

type RequestBodyDefinition

+ ContentType string

+ Default bool

+ NameTag string

+ func (r RequestBodyDefinition) Suffix() string

Jul 5, 2019

Changes in this version

+ func GenFieldsFromProperties(props []Property) []string

+ func GenStructFromSchema(schema Schema) string

+ func GenerateAdditionalPropertyBoilerplate(t *template.Template, typeDefs []TypeDefinition) (string, error)

+ func GenerateTypesForOperations(t *template.Template, ops []OperationDefinition) (string, error)

+ func PathToTypeName(path []string) string

+ func PropertiesEqual(a, b Property) bool

+ func SchemaHasAdditionalProperties(schema *openapi3.Schema) bool

+ func SortedStringKeys(dict map[string]string) []string

+ type FieldDescriptor struct

+ GoName string

+ GoType string

+ IsRef bool

+ JsonName string

+ Required bool

type OperationDefinition

+ TypeDefinitions []TypeDefinition

+ func (o *OperationDefinition) GetResponseTypeDefinitions() ([]TypeDefinition, error)

type ParameterDefinition

+ Schema Schema

+ func (pd ParameterDefinition) IndirectOptional() bool

+ type Property struct

+ JsonFieldName string

+ Required bool

+ Schema Schema

+ func (p Property) GoFieldName() string

+ func (p Property) GoTypeDef() string

type RequestBodyDefinition

+ Schema Schema

+ type Schema struct

+ AdditionalPropertiesType *Schema

+ AdditionalTypes []TypeDefinition

+ GoType string

+ HasAdditionalProperties bool

+ Properties []Property

+ RefType string

+ SkipOptionalPointer bool

+ func GenerateGoSchema(sref *openapi3.SchemaRef, path []string) (Schema, error)

+ func MergeSchemas(allOf []*openapi3.SchemaRef, path []string) (Schema, error)

+ func (s *Schema) MergeProperty(p Property) error

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

+ func (s Schema) IsRef() bool

+ func (s Schema) TypeDecl() string

type SchemaDescriptor

+ AdditionalPropertiesType string

+ Fields []FieldDescriptor

type TypeDefinition

+ JsonName string

+ Schema Schema

+ func GenerateParamsTypes(op OperationDefinition) []TypeDefinition

+ func GenerateTypeDefsForOperation(op OperationDefinition) []TypeDefinition

Jun 27, 2019

Changes in this version

+ func IsGoKeyword(str string) bool

+ func ParamToVariableName(param *openapi3.Parameter) string

+ func PrefixKeyword(str, prefix string) string

type OperationDefinition

+ func (o *OperationDefinition) SummaryAsComment() string

type ParameterDefinition

+ func (pd ParameterDefinition) GoVariableName() string

Jun 15, 2019

Changes in this version

+ func GenerateClientWithResponses(t *template.Template, ops []OperationDefinition) (string, error)

May 28, 2019

Changes in this version

+ func GenerateTypeDefinitions(t *template.Template, swagger *openapi3.Swagger, ops []OperationDefinition) (string, error)

+ func GenerateTypesForParams(t *template.Template, ops []OperationDefinition) (string, error)

+ func GenerateTypesForRequestBodies(t *template.Template, bodies map[string]*openapi3.RequestBodyRef) (string, error)

type Options

+ EmbedSpec bool

+ GenerateTypes bool

May 16, 2019

Changes in this version

+ func Generate(swagger *openapi3.Swagger, packageName string, opts Options) (string, error)

type OperationDefinition

+ func OperationDefinitions(swagger *openapi3.Swagger) ([]OperationDefinition, error)

+ type Options struct

+ GenerateClient bool

+ GenerateServer bool

May 10, 2019

Changes in this version

type SchemaDescriptor

+ HasAdditionalProperties bool

Apr 26, 2019

Changes in this version

+ func GenerateClient(t *template.Template, ops []OperationDefinition) (string, error)

+ func OrderedParamsFromUri(uri string) []string

+ func ReplacePathParamsWithStr(uri string) string

type OperationDefinition

+ func (o *OperationDefinition) GenerateGenericForm() bool

+ func (o *OperationDefinition) HasAnyBody() bool

+ func (o *OperationDefinition) HasGenericBody() bool

type ParameterDefinition

+ func SortParamsByPath(path string, in []ParameterDefinition) ([]ParameterDefinition, error)

+ type ParameterDefinitions []ParameterDefinition

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

Apr 15, 2019

Changes in this version

type OperationDefinition

+ Spec *openapi3.Operation

+ func (o *OperationDefinition) AllParams() []ParameterDefinition

type ParameterDefinition

+ Spec *openapi3.Parameter

+ func (pd *ParameterDefinition) Explode() bool

+ func (pd *ParameterDefinition) IsJson() bool

+ func (pd *ParameterDefinition) IsPassThrough() bool

+ func (pd *ParameterDefinition) IsStyled() bool

+ func (pd *ParameterDefinition) Style() string

Apr 9, 2019

Changes in this version

+ func GenerateInlinedSpec(t *template.Template, swagger *openapi3.Swagger) (string, error)

Mar 4, 2019

Changes in this version

+ var TemplateFunctions = template.FuncMap

+ func BindStringToObject(src string, dst interface{}) error

+ func GenFieldsFromSchemaDescriptors(desc []SchemaDescriptor) []string

+ func GenStructFromAllOf(allOf []*openapi3.SchemaRef) (string, error)

+ func GenStructFromSchemaDescriptors(desc []SchemaDescriptor) string

+ func GenerateImports(t *template.Template, imports []string, packageName string) (string, error)

+ func GeneratePathHandlers(t *template.Template, swagger *openapi3.Swagger) (string, error)

+ func GenerateRegistration(t *template.Template, ops []OperationDefinition) (string, error)

+ func GenerateServer(swagger *openapi3.Swagger, packageName string) (string, error)

+ func GenerateServerInterface(t *template.Template, ops []OperationDefinition) (string, error)

+ func GenerateTypes(t *template.Template, templateName string, types []TypeDefinition) (string, error)

+ func GenerateTypesForParameters(t *template.Template, params map[string]*openapi3.ParameterRef) (string, error)

+ func GenerateTypesForResponses(t *template.Template, responses openapi3.Responses) (string, error)

+ func GenerateTypesForRquestBodies(t *template.Template, bodies map[string]*openapi3.RequestBodyRef) (string, error)

+ func GenerateTypesForSchemas(t *template.Template, schemas map[string]*openapi3.SchemaRef) (string, error)

+ func GenerateWrappers(t *template.Template, ops []OperationDefinition) (string, error)

+ func LowercaseFirstCharacter(str string) string

+ func RefPathToGoType(refPath string) (string, error)

+ func SortedContentKeys(dict openapi3.Content) []string

+ func SortedOperationsKeys(dict map[string]*openapi3.Operation) []string

+ func SortedParameterKeys(dict map[string]*openapi3.ParameterRef) []string

+ func SortedPathsKeys(dict openapi3.Paths) []string

+ func SortedRequestBodyKeys(dict map[string]*openapi3.RequestBodyRef) []string

+ func SortedResponsesKeys(dict openapi3.Responses) []string

+ func SortedSchemaKeys(dict map[string]*openapi3.SchemaRef) []string

+ func StringInArray(str string, array []string) bool

+ func SwaggerUriToEchoUri(uri string) string

+ func ToCamelCase(str string) string

+ func UppercaseFirstCharacter(str string) string

+ type EchoRouter interface

+ CONNECT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ DELETE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ GET func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ HEAD func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ OPTIONS func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PATCH func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ POST func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ PUT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ TRACE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route

+ type OperationDefinition struct

+ Body *RequestBodyDefinition

+ CookieParams []ParameterDefinition

+ HeaderParams []ParameterDefinition

+ Method string

+ OperationId string

+ Path string

+ PathParams []ParameterDefinition

+ QueryParams []ParameterDefinition

+ Summary string

+ func (o *OperationDefinition) GetBodyDefinition() RequestBodyDefinition

+ func (o *OperationDefinition) HasBody() bool

+ func (o *OperationDefinition) Params() []ParameterDefinition

+ func (o *OperationDefinition) RequiresParamObject() bool

+ type ParameterDefinition struct

+ GoName string

+ In string

+ ParamName string

+ Reference string

+ Required bool

+ TypeDef string

+ func DescribeParameters(params openapi3.Parameters) ([]ParameterDefinition, error)

+ func FilterParameterDefinitionByType(params []ParameterDefinition, in string) []ParameterDefinition

+ func (pd *ParameterDefinition) JsonTag() string

+ type RequestBodyDefinition struct

+ CustomType bool

+ Required bool

+ TypeDef string

+ type SchemaDescriptor struct

+ GoName string

+ GoType string

+ IsRef bool

+ JsonName string

+ Required bool

+ func DescribeSchemaProperties(schema *openapi3.Schema) ([]SchemaDescriptor, error)

+ type TypeDefinition struct

+ JsonTypeName string

+ TypeDef string

+ TypeName string