generator

package

Go to main page

Versions in this module

v0

v0.26.0

Jan 12, 2021

Changes in this version

+ const AssetDebug

+ var DefaultLanguageFunc func() *LanguageOpts

+ var FuncMapFunc func(*LanguageOpts) template.FuncMap

+ func DefaultFuncMap(lang *LanguageOpts) template.FuncMap

+ func GenerateMarkdown(output string, modelNames, operationIDs []string, opts *GenOpts) error

+ func GenerateModels(modelNames []string, opts *GenOpts) error

+ func MarkdownSectionOpts(gen *GenOpts, output string)

+ func WithAutoXOrder(specPath string) string

type GenApp

+ APIPackageAlias string

+ PrincipalIsNullable bool

+ SecurityRequirements []analysis.SecurityRequirement

+ ServerPackageAlias string

+ Tags []spec.Tag

+ func (g *GenApp) UseFlags() bool

type GenHeader

+ func (h GenHeader) ToString() string

type GenItems

+ NeedsIndex bool

+ func (g GenItems) ToString() string

+ func (g GenItems) UnderlyingType() string

type GenOperation

+ Consumes []string

+ ExternalDocs *spec.ExternalDocumentation

+ ExtraSchemeOverrides []string

+ PackageAlias string

+ PrincipalIsNullable bool

+ Produces []string

+ SchemeOverrides []string

+ SecurityRequirements []analysis.SecurityRequirement

+ StrictResponders bool

+ UseTags bool

type GenOperationGroup

+ PackageAlias string

type GenOpts

+ AcceptDefinitionsOnly bool

+ AllowEnumCI bool

+ AllowTemplateOverride bool

+ IgnoreOperations bool

+ MainPackage string

+ PrincipalCustomIface bool

+ PropertiesSpecOrder bool

+ SkipTagPackages bool

+ StrictAdditionalProperties bool

+ StrictResponders bool

+ StructTags []string

+ WithXML bool

+ func (g *GenOpts) PrincipalAlias() string

+ func (g *GenOpts) PrincipalIsNullable() bool

type GenParameter

+ func (g GenParameter) ToString() string

+ func (g GenParameter) UnderlyingType() string

type GenResponse

+ Examples GenResponseExamples

+ OperationName string

+ StrictResponders bool

+ type GenResponseExample struct

+ Example interface{}

+ MediaType string

+ type GenResponseExamples []GenResponseExample

+ func (g GenResponseExamples) Len() int

+ func (g GenResponseExamples) Less(i, j int) bool

+ func (g GenResponseExamples) Swap(i, j int)

type GenSchema

+ ExternalDocs *spec.ExternalDocumentation

+ ExtraImports map[string]string

+ StrictAdditionalProperties bool

+ StructTags []string

+ WantsMarshalBinary bool

+ func (g GenSchema) PrintTags() string

+ func (g GenSchema) ToString() string

+ func (g GenSchema) UnderlyingType() string

type GenSecurityScheme

+ PrincipalIsNullable bool

+ ScopesDesc []GenSecurityScope

+ type GenSecurityScope struct

+ Description string

+ Name string

type GenSerializer

+ Parameters []string

type LanguageOpts

+ ArrayInitializerFunc func(interface{}) (string, error)

+ ImportsFunc func(map[string]string) string

+ func MarkdownOpts() *LanguageOpts

type Repository

+ func (t *Repository) SetAllowOverride(value bool)

+ func (t *Repository) ShallowClone() *Repository

v0.19.0

Mar 20, 2019

v0.18.0

Dec 22, 2018

Changes in this version

type GenOpts

+ func (g *GenOpts) CheckOpts() error

type LanguageOpts

+ func (l *LanguageOpts) ManglePackageName(name, suffix string) string

+ func (l *LanguageOpts) ManglePackagePath(name string, suffix string) string

v0.17.2

Oct 25, 2018

v0.17.1

Oct 22, 2018

Changes in this version

+ func AssetDigest(name string) ([sha256.Size]byte, error)

+ func AssetString(name string) (string, error)

+ func Digests() (map[string][sha256.Size]byte, error)

+ func MustAssetString(name string) string

v0.17.0

Oct 7, 2018

Changes in this version

+ var Debug = os.Getenv("DEBUG") != "" || os.Getenv("SWAGGER_DEBUG") != ""

+ func AddFile(name, data string) error

+ func DefaultSectionOpts(gen *GenOpts)

+ func GenerateServer(name string, modelNames, operationIDs []string, opts *GenOpts) error

+ func ReadConfig(fpath string) (*viper.Viper, error)

type GenApp

+ APIPackage string

+ ExcludeSpec bool

+ ExtraSchemes []string

+ FlatSwaggerJSON string

+ GenOpts *GenOpts

+ WithContext bool

+ func (g *GenApp) UseGoStructFlags() bool

+ func (g *GenApp) UseIntermediateMode() bool

+ func (g *GenApp) UseModernMode() bool

+ func (g *GenApp) UsePFlags() bool

+ type GenCommon struct

+ Copyright string

+ TargetImportPath string

type GenDefinition

+ External bool

+ type GenDefinitions []GenDefinition

+ func (g GenDefinitions) Len() int

+ func (g GenDefinitions) Less(i, j int) bool

+ func (g GenDefinitions) Swap(i, j int)

type GenHeader

+ Child *GenItems

+ CollectionFormat string

+ HasDefault bool

+ ID string

+ IndexVar string

+ Parent *GenItems

+ ValueExpression string

+ ZeroValue string

+ func (g *GenHeader) ItemsDepth() string

type GenHeaders

+ func (g GenHeaders) HasSomeDefaults() bool

type GenItems

+ IndexVar string

+ KeyVar string

+ SkipParse bool

+ func (g *GenItems) ItemsDepth() string

type GenOperation

+ BasePath string

+ ConsumesMediaTypes []string

+ Extensions map[string]interface{}

+ ExtraSchemes []string

+ HasBodyParams bool

+ HasFormValueParams bool

+ HasHeaderParams bool

+ HasPathParams bool

+ HasStreamingResponse bool

+ ProducesMediaTypes []string

+ Security []GenSecurityRequirements

+ SecurityDefinitions GenSecuritySchemes

+ SuccessResponses []GenResponse

+ TimeoutName string

+ WithContext bool

type GenOperationGroup

+ GenOpts *GenOpts

+ WithContext bool

type GenOpts

+ CompatibilityMode string

+ Copyright string

+ DefaultConsumes string

+ DefaultProduces string

+ ExcludeSpec bool

+ ExistingModels string

+ FlagStrategy string

+ FlattenOpts *analysis.FlattenOpts

+ IncludeHandler bool

+ IncludeMain bool

+ IncludeModel bool

+ IncludeParameters bool

+ IncludeResponses bool

+ IncludeSupport bool

+ IncludeURLBuilder bool

+ IncludeValidator bool

+ IsClient bool

+ LanguageOpts *LanguageOpts

+ Models []string

+ Name string

+ Operations []string

+ RegenerateConfigureAPI bool

+ Sections SectionOpts

+ Tags []string

+ Template string

+ TemplateDir string

+ ValidateSpec bool

+ WithContext bool

+ func (g *GenOpts) EnsureDefaults() error

+ func (g *GenOpts) SpecPath() string

+ func (g *GenOpts) TargetPath() string

type GenParameter

+ Extensions map[string]interface{}

+ HasDefault bool

+ HasModelBodyItems bool

+ HasModelBodyMap bool

+ HasModelBodyParams bool

+ HasSimpleBodyItems bool

+ HasSimpleBodyMap bool

+ HasSimpleBodyParams bool

+ ID string

+ KeyVar string

+ func (g *GenParameter) ItemsDepth() string

type GenParameters

+ func (g GenParameters) HasSomeDefaults() bool

type GenResponse

+ AllowsForStreaming bool

+ Extensions map[string]interface{}

type GenSchema

+ CustomTag string

+ Default interface{}

+ IncludeModel bool

+ IncludeValidator bool

+ OriginalName string

+ type GenSecurityRequirement struct

+ Name string

+ Scopes []string

+ type GenSecurityRequirements []GenSecurityRequirement

+ func (g GenSecurityRequirements) Len() int

+ func (g GenSecurityRequirements) Less(i, j int) bool

+ func (g GenSecurityRequirements) Swap(i, j int)

type GenSecurityScheme

+ AuthorizationURL string

+ Description string

+ Extensions map[string]interface{}

+ Flow string

+ In string

+ IsOAuth2 bool

+ Scopes []string

+ TokenURL string

+ Type string

+ type GenSecuritySchemes []GenSecurityScheme

+ func (g GenSecuritySchemes) Len() int

+ func (g GenSecuritySchemes) Less(i, j int) bool

+ func (g GenSecuritySchemes) Swap(i, j int)

+ type GenSerGroups []GenSerGroup

+ func (g GenSerGroups) Len() int

+ func (g GenSerGroups) Less(i, j int) bool

+ func (g GenSerGroups) Swap(i, j int)

+ type GenSerializers []GenSerializer

+ func (g GenSerializers) Len() int

+ func (g GenSerializers) Less(i, j int) bool

+ func (g GenSerializers) Swap(i, j int)

+ type GenStatusCodeResponses []GenResponse

+ func (g *GenStatusCodeResponses) UnmarshalJSON(data []byte) error

+ func (g GenStatusCodeResponses) Len() int

+ func (g GenStatusCodeResponses) Less(i, j int) bool

+ func (g GenStatusCodeResponses) MarshalJSON() ([]byte, error)

+ func (g GenStatusCodeResponses) Swap(i, j int)

+ type LanguageConfig map[string]LanguageDefinition

+ type LanguageDefinition struct

+ Layout SectionOpts

+ func (d *LanguageDefinition) ConfigureOpts(opts *GenOpts) error

+ type LanguageOpts struct

+ BaseImportFunc func(string) string

+ ReservedWords []string

+ func GoLangOpts() *LanguageOpts

+ func (l *LanguageOpts) FormatContent(name string, content []byte) ([]byte, error)

+ func (l *LanguageOpts) Init()

+ func (l *LanguageOpts) MangleFileName(name string) string

+ func (l *LanguageOpts) MangleName(name, suffix string) string

+ func (l *LanguageOpts) MangleVarName(name string) string

+ type Repository struct

+ func NewRepository(funcs template.FuncMap) *Repository

+ func (t *Repository) AddFile(name, data string) error

+ func (t *Repository) DumpTemplates()

+ func (t *Repository) Get(name string) (*template.Template, error)

+ func (t *Repository) LoadContrib(name string) error

+ func (t *Repository) LoadDefaults()

+ func (t *Repository) LoadDir(templatePath string) error

+ func (t *Repository) MustGet(name string) *template.Template

+ type SectionOpts struct

+ Application []TemplateOpts

+ Models []TemplateOpts

+ OperationGroups []TemplateOpts

+ Operations []TemplateOpts

+ type TemplateOpts struct

+ FileName string

+ Name string

+ SkipExists bool

+ SkipFormat bool

+ Source string

+ Target string

v0.2.0

Dec 25, 2015

Changes in this version

type GenHeader

+ Default interface{}

type GenOperation

+ RootPackage string

type GenOperationGroup

+ RootPackage string

type GenResponse

+ Method string

+ Path string

v0.1.0

Dec 14, 2015

Changes in this version

+ var FuncMap template.FuncMap = map[string]interface

+ func Asset(name string) ([]byte, error)

+ func AssetDir(name string) ([]string, error)

+ func AssetInfo(name string) (os.FileInfo, error)

+ func AssetNames() []string

+ func GenerateClient(name string, modelNames, operationIDs []string, opts GenOpts) error

+ func GenerateDefinition(modelNames []string, includeModel, includeValidator bool, opts GenOpts) error

+ func GenerateServerOperation(operationNames, tags []string, ...) error

+ func GenerateSupport(name string, modelNames, operationIDs []string, opts GenOpts) error

+ func MustAsset(name string) []byte

+ func RestoreAsset(dir, name string) error

+ func RestoreAssets(dir, name string) error

+ type GenApp struct

+ BasePath string

+ Consumes []GenSerGroup

+ DefaultConsumes string

+ DefaultImports []string

+ DefaultProduces string

+ ExternalDocs *spec.ExternalDocumentation

+ Host string

+ Imports map[string]string

+ Info *spec.Info

+ Models []GenDefinition

+ Name string

+ OperationGroups GenOperationGroups

+ Operations GenOperations

+ Package string

+ Principal string

+ Produces []GenSerGroup

+ ReceiverName string

+ Schemes []string

+ SecurityDefinitions []GenSecurityScheme

+ SwaggerJSON string

+ type GenDefinition struct

+ DefaultImports []string

+ DependsOn []string

+ ExtraSchemas []GenSchema

+ Imports map[string]string

+ IncludeValidator bool

+ Package string

+ func (rt *GenDefinition) Zero() string

+ type GenHeader struct

+ Converter string

+ Description string

+ Formatter string

+ Name string

+ Package string

+ Path string

+ ReceiverName string

+ Title string

+ func (rt *GenHeader) Zero() string

+ type GenHeaders []GenHeader

+ func (g GenHeaders) Len() int

+ func (g GenHeaders) Less(i, j int) bool

+ func (g GenHeaders) Swap(i, j int)

+ type GenItems struct

+ Child *GenItems

+ CollectionFormat string

+ Converter string

+ Formatter string

+ Location string

+ Name string

+ Parent *GenItems

+ Path string

+ ValueExpression string

+ func (rt *GenItems) Zero() string

+ type GenOperation struct

+ Authorized bool

+ DefaultImports []string

+ DefaultResponse *GenResponse

+ Description string

+ ExtraSchemas []GenSchema

+ FormParams GenParameters

+ HasFileParams bool

+ HasFormParams bool

+ HasQueryParams bool

+ HeaderParams GenParameters

+ Imports map[string]string

+ Method string

+ Name string

+ Package string

+ Params GenParameters

+ Path string

+ PathParams GenParameters

+ Principal string

+ QueryParams GenParameters

+ ReceiverName string

+ Responses map[int]GenResponse

+ Schemes []string

+ SuccessResponse *GenResponse

+ Summary string

+ Tags []string

+ type GenOperationGroup struct

+ DefaultImports []string

+ Description string

+ Imports map[string]string

+ Name string

+ Operations GenOperations

+ Summary string

+ type GenOperationGroups []GenOperationGroup

+ func (g GenOperationGroups) Len() int

+ func (g GenOperationGroups) Less(i, j int) bool

+ func (g GenOperationGroups) Swap(i, j int)

+ type GenOperations []GenOperation

+ func (g GenOperations) Len() int

+ func (g GenOperations) Less(i, j int) bool

+ func (g GenOperations) Swap(i, j int)

+ type GenOpts struct

+ APIPackage string

+ ClientPackage string

+ DefaultScheme string

+ DumpData bool

+ Imports map[string]string

+ ModelPackage string

+ Principal string

+ ServerPackage string

+ Spec string

+ Target string

+ TypeMapping map[string]string

+ type GenParameter struct

+ AllowEmptyValue bool

+ BodyParam *GenParameter

+ Child *GenItems

+ CollectionFormat string

+ Converter string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ Formatter string

+ IndexVar string

+ Location string

+ ModelsPackage string

+ Name string

+ Parent *GenItems

+ Path string

+ ReceiverName string

+ Schema *GenSchema

+ Title string

+ ValueExpression string

+ ZeroValue string

+ func (g *GenParameter) IsBodyParam() bool

+ func (g *GenParameter) IsFileParam() bool

+ func (g *GenParameter) IsFormParam() bool

+ func (g *GenParameter) IsHeaderParam() bool

+ func (g *GenParameter) IsPathParam() bool

+ func (g *GenParameter) IsQueryParam() bool

+ func (rt *GenParameter) Zero() string

+ type GenParameters []GenParameter

+ func (g GenParameters) Len() int

+ func (g GenParameters) Less(i, j int) bool

+ func (g GenParameters) Swap(i, j int)

+ type GenResponse struct

+ Code int

+ DefaultImports []string

+ Description string

+ Headers GenHeaders

+ Imports map[string]string

+ IsSuccess bool

+ ModelsPackage string

+ Name string

+ Package string

+ ReceiverName string

+ Schema *GenSchema

+ type GenSchema struct

+ AdditionalItems *GenSchema

+ AdditionalProperties *GenSchema

+ AllOf []GenSchema

+ AllowsAdditionalItems bool

+ Description string

+ Discriminates map[string]string

+ DiscriminatorField string

+ DiscriminatorValue string

+ Example string

+ HasAdditionalItems bool

+ HasAdditionalProperties bool

+ HasBaseType bool

+ IndexVar string

+ IsAdditionalProperties bool

+ IsBaseType bool

+ IsExported bool

+ IsSubType bool

+ IsVirtual bool

+ Items *GenSchema

+ KeyVar string

+ Location string

+ Name string

+ Object *GenSchema

+ Parents []string

+ Path string

+ Properties GenSchemaList

+ ReadOnly bool

+ ReceiverName string

+ Suffix string

+ Title string

+ ValueExpression string

+ XMLName string

+ func (rt *GenSchema) Zero() string

+ type GenSchemaList []GenSchema

+ func (g GenSchemaList) Len() int

+ func (g GenSchemaList) Less(i, j int) bool

+ func (g GenSchemaList) Swap(i, j int)

+ type GenSecurityScheme struct

+ AppName string

+ ID string

+ IsAPIKeyAuth bool

+ IsBasicAuth bool

+ Name string

+ Principal string

+ ReceiverName string

+ Source string

+ type GenSerGroup struct

+ AllSerializers []GenSerializer

+ AppName string

+ Implementation string

+ MediaType string

+ Name string

+ ReceiverName string

+ type GenSerializer struct

+ AppName string

+ Implementation string

+ MediaType string

+ Name string

+ ReceiverName string

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