codegen

package

Go to main page

Versions in this module

v2

v2.1.21

Dec 15, 2022

v2.1.20

Nov 10, 2022

v2.1.19

Nov 4, 2022

Changes in this version

type Configuration

+ Imports []Import

+ type Import struct

+ Name string

+ Path string

+ func (i Import) String() string

v2.1.18

Nov 3, 2022

Changes in this version

type OutputOptions

+ ExplicitNullablePrimitives bool

v2.1.17

Oct 17, 2022

v2.1.16

Sep 28, 2022

v2.1.15

Sep 14, 2022

v2.1.14

Sep 2, 2022

Changes in this version

+ func SortedMediaTypeKeys(dict map[string]*openapi3.MediaType) []string

type Schema

+ func (s Schema) HasCustomMarshalling() bool

v2.1.13

Sep 2, 2022

v2.1.12

Sep 2, 2022

v2.1.11

Aug 24, 2022

Changes in this version

type OperationDefinition

+ func (o *OperationDefinition) HasDefaults() bool

type Schema

+ func (s Schema) HasDefaults() bool

v2.1.10

Aug 18, 2022

v2.1.9

Aug 17, 2022

v2.1.8

Aug 15, 2022

v2.1.7

Aug 15, 2022

v2.1.6

Aug 15, 2022

Changes in this version

type Schema

+ func (s Schema) Comments() string

v2.1.5

Aug 5, 2022

v2.1.4

Aug 5, 2022

v2.1.3

Aug 5, 2022

v2.1.2

Aug 5, 2022

Changes in this version

type OutputOptions

+ DeepStructsAliases map[string]string

+ GenerateDeepStructs bool

v2.1.1

Jul 11, 2022

v2.1.0

Jun 2, 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 OperationOption struct

+ Exclude bool

+ Method string

+ Params []ParamOption

+ Path string

+ type OutputOptions struct

+ ExcludeSchemas []string

+ ExcludeTags []string

+ ExplicitNullable bool

+ IncludeTags []string

+ OmitReqEditors bool

+ Operations []OperationOption

+ ResponseTypeSuffix string

+ SkipFmt bool

+ SkipPrune bool

+ UserTemplates map[string]string

+ type ParamOption struct

+ Exclude bool

+ Name string

type Property

+ NeedsFormTag bool

+ ReadOnly bool

+ WriteOnly bool

type Schema

+ DefineViaAlias bool

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

type TypeDefinition

+ func (t *TypeDefinition) IsAlias() bool

v2.0.10

May 30, 2022

Changes in this version

type Options

+ NoReqEditors bool

v2.0.9

Apr 12, 2022

Changes in this version

type Options

+ ExplicitNullable bool

v2.0.8

Mar 15, 2022

v2.0.7

Mar 14, 2022

v2.0.6

Mar 10, 2022

Changes in this version

type Schema

+ func (s Schema) IsAdditionalPropertiesOnly() bool

v2.0.5

Mar 9, 2022

v2.0.4

Mar 9, 2022

v2.0.3

Mar 8, 2022

Changes in this version

type TypeDefinition

+ func (t *TypeDefinition) IsCustomType() bool

v2.0.2

Mar 7, 2022

Changes in this version

type OperationDefinition

+ Middlewares []string

v2.0.1

Mar 4, 2022

Changes in this version

+ var TemplateFunctions = template.FuncMap

+ func EscapePathElements(path string) string

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

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

+ func GenStructFromSchema(schema Schema) string

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

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

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

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

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

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

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

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

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

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

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

+ func GenerateInlinedSpec(t *template.Template, importMapping importMap, swagger *openapi3.T) (string, error)

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

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

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

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

+ func IsGoIdentity(str string) bool

+ func IsGoKeyword(str string) bool

+ func IsGoTypeReference(ref string) bool

+ func IsPredeclaredGoIdentifier(str string) bool

+ func IsValidGoIdentity(str string) bool

+ func IsWholeDocumentReference(ref string) bool

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

+ func LowercaseFirstCharacter(str string) string

+ func OrderedParamsFromUri(uri string) []string

+ func PathToTypeName(path []string) string

+ func PropertiesEqual(a, b Property) bool

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

+ func ReplacePathParamsWithStr(uri string) string

+ func SanitizeCode(goCode string) string

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

+ func SanitizeGoIdentity(str string) string

+ func SchemaHasAdditionalProperties(schema *openapi3.Schema) bool

+ func SchemaNameToTypeName(name string) string

+ 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 SortedSecurityRequirementKeys(sr openapi3.SecurityRequirement) []string

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

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

+ func StringToGoComment(in string) string

+ func SwaggerUriToChiUri(uri string) string

+ func SwaggerUriToEchoUri(uri string) string

+ func SwaggerUriToGinUri(uri string) string

+ func ToCamelCase(str string) string

+ func UppercaseFirstCharacter(str string) string

+ type Constants struct

+ EnumDefinitions []EnumDefinition

+ SecuritySchemeProviderNames []string

+ type EnumDefinition struct

+ Schema Schema

+ TypeName string

+ ValueWrapper string

+ type FieldDescriptor struct

+ GoName string

+ GoType string

+ IsRef bool

+ JsonName string

+ Required bool

+ type OperationDefinition struct

+ Bodies []RequestBodyDefinition

+ BodyRequired bool

+ CookieParams []ParameterDefinition

+ HeaderParams []ParameterDefinition

+ Method string

+ OperationId string

+ Path string

+ PathParams []ParameterDefinition

+ QueryParams []ParameterDefinition

+ Responses []ResponseTypeDefinition

+ SecurityDefinitions []SecurityDefinition

+ Spec *openapi3.Operation

+ Summary string

+ TypeDefinitions []TypeDefinition

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

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

+ func (o *OperationDefinition) HasBody() bool

+ func (o *OperationDefinition) IsAllEmptyResponses() bool

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

+ func (o *OperationDefinition) RequiresParamObject() bool

+ func (o *OperationDefinition) SummaryAsComment() string

+ type Options struct

+ AliasTypes bool

+ EmbedSpec bool

+ ExcludeSchemas []string

+ ExcludeTags []string

+ GenerateChiServer bool

+ GenerateClient bool

+ GenerateEchoServer bool

+ GenerateGinServer bool

+ GenerateTypes bool

+ ImportMapping map[string]string

+ IncludeTags []string

+ SkipFmt bool

+ SkipPrune bool

+ UserTemplates map[string]string

+ type ParameterDefinition struct

+ In string

+ ParamName string

+ Required bool

+ Schema Schema

+ Spec *openapi3.Parameter

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

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

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

+ func (pd *ParameterDefinition) Explode() bool

+ func (pd *ParameterDefinition) IsJson() bool

+ func (pd *ParameterDefinition) IsPassThrough() bool

+ func (pd *ParameterDefinition) IsStyled() bool

+ func (pd *ParameterDefinition) JsonTag() string

+ func (pd *ParameterDefinition) Style() string

+ func (pd ParameterDefinition) GoName() string

+ func (pd ParameterDefinition) GoVariableName() string

+ func (pd ParameterDefinition) IndirectOptional() bool

+ func (pd ParameterDefinition) TypeDef() string

+ type ParameterDefinitions []ParameterDefinition

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

+ type Property struct

+ Description string

+ ExtensionProps *openapi3.ExtensionProps

+ JsonFieldName string

+ Nullable bool

+ Required bool

+ Schema Schema

+ func (p Property) GoFieldName() string

+ func (p Property) GoTypeDef() string

+ type RefWrapper struct

+ HasValue bool

+ Ref string

+ SourceRef interface{}

+ type RequestBodyDefinition struct

+ ContentType string

+ Default bool

+ NameTag string

+ Required bool

+ Schema Schema

+ func (r RequestBodyDefinition) CustomType() bool

+ func (r RequestBodyDefinition) Suffix() string

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

+ type ResponseTypeDefinition struct

+ ContentTypeName string

+ ResponseName string

+ func (t *ResponseTypeDefinition) IsGenericError() bool

+ type Schema struct

+ AdditionalPropertiesType *Schema

+ AdditionalTypes []TypeDefinition

+ ArrayType *Schema

+ Description string

+ EnumValues map[string]string

+ GoType string

+ HasAdditionalProperties bool

+ OAPISchema *openapi3.Schema

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

+ AdditionalPropertiesType string

+ Fields []FieldDescriptor

+ HasAdditionalProperties bool

+ type SecurityDefinition struct

+ ProviderName string

+ Scopes []string

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

+ type TypeDefinition struct

+ JsonName string

+ Schema Schema

+ TypeName string

+ func GenerateParamsTypes(op OperationDefinition) []TypeDefinition

+ func GenerateTypeDefsForOperation(op OperationDefinition) []TypeDefinition

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

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

+ func GenerateTypesForResponses(t *template.Template, responses openapi3.Responses) ([]TypeDefinition, error)

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

+ func (t *TypeDefinition) CanAlias() bool

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