swag

package module

Go to main page

Versions in this module

v1

v1.7.11

Jan 12, 2022

v1.7.10

Jan 12, 2022

v1.7.9

Jan 12, 2022

v1.7.7

Jan 12, 2022

Changes in this version

+ const ANY

+ const ARRAY

+ const BOOLEAN

+ const FUNC

+ const INTEGER

+ const NIL

+ const NUMBER

+ const OBJECT

+ const PRIMITIVE

+ const STRING

+ var ErrFuncTypeField = errors.New("field type is func")

+ var ErrRecursiveParseStruct = errors.New("recursively parsing struct")

+ var ErrSkippedField = errors.New("field is skipped by global overrides")

+ func BuildCustomSchema(types []string) (*spec.Schema, error)

+ func IsNumericType(typeName string) bool

+ func IsSimplePrimitiveType(typeName string) bool

+ func PrimitiveSchema(refType string) *spec.Schema

+ func RefSchema(refType string) *spec.Schema

+ func SetCodeExampleFilesDirectory(directoryPath string) func(*Operation)

+ func SetCodeExamplesDirectory(directoryPath string) func(*Parser)

+ func SetDebugger(logger Debugger) func(parser *Parser)

+ func SetExcludedDirsAndFiles(excludes string) func(*Parser)

+ func SetFieldParserFactory(factory FieldParserFactory) func(parser *Parser)

+ func SetMarkdownFileDirectory(directoryPath string) func(*Parser)

+ func SetOverrides(overrides map[string]string) func(parser *Parser)

+ func SetStrict(strict bool) func(*Parser)

+ func TransToValidCollectionFormat(format string) string

+ func TypeDocName(pkgName string, spec *ast.TypeSpec) string

+ type AstFileInfo struct

+ File *ast.File

+ PackagePath string

+ Path string

+ type Debugger interface

+ Printf func(format string, v ...interface{})

+ type FieldParser interface

+ ComplementSchema func(schema *spec.Schema) error

+ CustomSchema func() (*spec.Schema, error)

+ FieldName func() (string, error)

+ IsRequired func() (bool, error)

+ ShouldSkip func() (bool, error)

+ type FieldParserFactory func(ps *Parser, field *ast.Field) FieldParser

+ type Formater struct

+ func NewFormater() *Formater

+ func (f *Formater) FormatAPI(searchDir, excludeDir, mainFile string) error

+ func (f *Formater) FormatFile(filepath string) error

+ func (f *Formater) FormatMain(mainFilepath string) error

type Operation

+ RouterProperties []RouteProperties

+ func (operation *Operation) AddResponse(code int, response *spec.Response)

+ func (operation *Operation) DefaultResponse() *spec.Response

+ func (operation *Operation) ParseCodeSample(attribute, _, lineRemainder string) error

+ func (operation *Operation) ParseDescriptionComment(lineRemainder string)

+ func (operation *Operation) ParseMetadata(attribute, lowerAttribute, lineRemainder string) error

+ func (operation *Operation) ParseResponseHeaderComment(commentLine string, _ *ast.File) error

+ type PackageDefinitions struct

+ Files map[string]*ast.File

+ Name string

+ TypeDefinitions map[string]*TypeSpecDef

+ type PackagesDefinitions struct

+ func NewPackagesDefinitions() *PackagesDefinitions

+ func (pkgs *PackagesDefinitions) CollectAstFile(packageDir, path string, astFile *ast.File) error

+ func (pkgs *PackagesDefinitions) FindTypeSpec(typeName string, file *ast.File, parseDependency bool) *TypeSpecDef

+ func (pkgs *PackagesDefinitions) ParseTypes() (map[*TypeSpecDef]*Schema, error)

type Parser

+ Overrides map[string]string

+ ParseDependency bool

+ ParseInternal bool

+ ParseVendor bool

+ Strict bool

+ func (parser *Parser) GetSchemaTypePath(schema *spec.Schema, depth int) []string

+ func (parser *Parser) ParseAPIMultiSearchDir(searchDirs []string, mainAPIFile string, parseDepth int) error

+ func (parser *Parser) ParseAcceptComment(commentLine string) error

+ func (parser *Parser) ParseProduceComment(commentLine string) error

+ func (parser *Parser) Skip(path string, f os.FileInfo) error

+ type RouteProperties struct

+ HTTPMethod string

+ Path string

+ type Schema struct

+ Name string

+ PkgPath string

+ type TypeSpecDef struct

+ File *ast.File

+ PkgPath string

+ TypeSpec *ast.TypeSpec

+ func (t *TypeSpecDef) FullName() string

+ func (t *TypeSpecDef) FullPath() string

+ func (t *TypeSpecDef) Name() string

v1.4.0

Sep 5, 2018

Changes in this version

+ const CamelCase

+ const PascalCase

+ const SnakeCase

+ var ErrFailedConvertPrimitiveType = errors.New("swag property: failed convert primitive type")

+ func IsGolangPrimitiveType(typeName string) bool

+ func IsPrimitiveType(typeName string) bool

type Operation

+ func (operation *Operation) ParseEmptyResponseOnly(commentLine string) error

type Parser

+ CustomPrimitiveTypes map[string]string

v1.3.2

Jun 12, 2018

Changes in this version

+ const Version

+ func Skip(f os.FileInfo) error

type Operation

+ HTTPMethod string

+ func (operation *Operation) ParseSecurityComment(commentLine string) error

type Parser

+ PropNamingStrategy string

+ func (parser *Parser) ParseAPI(searchDir string, mainAPIFile string)

+ func (parser *Parser) ParseGeneralAPIInfo(mainAPIFile string)

+ func (parser *Parser) ParseRouterAPIInfo(astFile *ast.File)

v1.1.1

Feb 22, 2018

Changes in this version

+ func CheckSchemaType(typeName string)

+ func TransToValidSchemeType(typeName string) string

type Parser

+ func (parser *Parser) ParseDefinition(pkgName string, typeSpec *ast.TypeSpec, typeName string)

v1.1.0

Feb 4, 2018

Changes in this version

type Operation

+ func (operation *Operation) ParseTagsComment(commentLine string)

v1.0.0

Nov 30, 2017

Changes in this version

+ const Name

+ func GetSchemes(commentLine string) []string

+ func ReadDoc() (string, error)

+ func Register(name string, swagger Swagger)

+ type Operation struct

+ HttpMethod string

+ Path string

+ func NewOperation() *Operation

+ func (operation *Operation) ParseAcceptComment(commentLine string) error

+ func (operation *Operation) ParseComment(comment string) error

+ func (operation *Operation) ParseEmptyResponseComment(commentLine string) error

+ func (operation *Operation) ParseParamComment(commentLine string) error

+ func (operation *Operation) ParseProduceComment(commentLine string) error

+ func (operation *Operation) ParseResponseComment(commentLine string) error

+ func (operation *Operation) ParseRouterComment(commentLine string) error

+ type Parser struct

+ TypeDefinitions map[string]map[string]*ast.TypeSpec

+ func New() *Parser

+ func (parser *Parser) GetSwagger() *spec.Swagger

+ func (parser *Parser) ParseApi(searchDir string, mainApiFile string)

+ func (parser *Parser) ParseDefinitions()

+ func (parser *Parser) ParseGeneralApiInfo(mainApiFile string)

+ func (parser *Parser) ParseRouterApiInfo(astFile *ast.File)

+ func (parser *Parser) ParseType(astFile *ast.File)

+ type Swagger interface

+ ReadDoc func() string

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