swag

Feb 1, 2024

Changes in this version

type FieldParser

+ HeaderName func() string

+ PathName func() string

type Operation

+ State string

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

type Parser

+ HostState string

type RouteProperties

+ Deprecated bool

Aug 30, 2023

Changes in this version

+ func SetPackagePrefix(packagePrefix string) func(*Parser)

Apr 17, 2023

Changes in this version

type Spec

+ LeftDelim string

+ RightDelim string

Mar 28, 2023

Changes in this version

+ func MergeSchema(dst *spec.Schema, src *spec.Schema) *spec.Schema

Mar 21, 2023

Changes in this version

+ func SetCollectionFormat(collectionFormat string) func(*Parser)

type FieldParser

+ FormName func() string

Jan 25, 2023

Changes in this version

+ const ParseAll

+ const ParseModels

+ const ParseNone

+ const ParseOperations

type AstFileInfo

+ ParseFlag ParseFlag

+ type ParseFlag int

Dec 15, 2022

Changes in this version

+ func AppendUtf8Rune(p []byte, r rune) []byte

+ func EvaluateBinary(x, y interface{}, operator token.Token, xtype, ytype ast.Expr) (interface{}, ast.Expr)

+ func EvaluateDataConversion(x interface{}, typeName string) interface

+ func EvaluateEscapedChar(text string) rune

+ func EvaluateEscapedString(text string) string

+ func EvaluateUnary(x interface{}, operator token.Token, xtype ast.Expr) (interface{}, ast.Expr)

+ func FieldsByAnySpace(s string, n int) []string

+ func FieldsFunc(s string, f func(rune2 rune) bool, n int) []string

+ func SetParseExtension(parseExtension string) func(*Parser)

type AstFileInfo

+ FileSet *token.FileSet

+ type CanIntegerValue struct

+ func (v CanIntegerValue) CanInt() bool

+ func (v CanIntegerValue) CanUint() bool

type ConstVariableGlobalEvaluator

+ FindTypeSpec func(typeName string, file *ast.File) *TypeSpecDef

type PackagesDefinitions

+ func (pkgDefs *PackagesDefinitions) ParseFile(packageDir, path string, src interface{}) error

Nov 23, 2022

Changes in this version

+ func IsComplexSchema(schema *spec.Schema) bool

+ func IsRefSchema(schema *spec.Schema) bool

+ func SetParseDependency(parseDependency bool) func(*Parser)

+ func SetTags(include string) func(*Parser)

+ type ConstVariable struct

+ Comment *ast.CommentGroup

+ File *ast.File

+ Name *ast.Ident

+ Pkg *PackageDefinitions

+ Type ast.Expr

+ Value interface{}

+ type ConstVariableGlobalEvaluator interface

+ EvaluateConstValue func(pkg *PackageDefinitions, cv *ConstVariable, recursiveStack map[string]struct{}) (interface{}, ast.Expr)

+ EvaluateConstValueByName func(file *ast.File, pkgPath, constVariableName string, ...) (interface{}, ast.Expr)

+ type EnumValue struct

+ Comment string

+ Value interface{}

type PackageDefinitions

+ ConstTable map[string]*ConstVariable

+ OrderedConst []*ConstVariable

+ Path string

+ func NewPackageDefinitions(name, pkgPath string) *PackageDefinitions

+ func (pkg *PackageDefinitions) AddConst(astFile *ast.File, valueSpec *ast.ValueSpec) *PackageDefinitions

+ func (pkg *PackageDefinitions) AddFile(pkgPath string, file *ast.File) *PackageDefinitions

+ func (pkg *PackageDefinitions) AddTypeSpec(name string, typeSpec *TypeSpecDef) *PackageDefinitions

type PackagesDefinitions

+ func (pkgDefs *PackagesDefinitions) EvaluateConstValue(pkg *PackageDefinitions, cv *ConstVariable, recursiveStack map[string]struct{}) (interface{}, ast.Expr)

+ func (pkgDefs *PackagesDefinitions) EvaluateConstValueByName(file *ast.File, pkgName, constVariableName string, ...) (interface{}, ast.Expr)

type TypeSpecDef

+ Enums []EnumValue

+ NotUnique bool

+ func (t *TypeSpecDef) TypeName() string

Nov 26, 2021

Changes in this version

+ 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

Oct 15, 2020

Changes in this version

type PackagesDefinitions

+ func (pkgs *PackagesDefinitions) RangeFiles(handle func(filename string, file *ast.File) error) error

Jan 5, 2020

Changes in this version

type Parser

+ ImportAliases map[string]map[string]*ast.ImportSpec

Mar 26, 2019

Changes in this version

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

+ func Println(v ...interface{})

Sep 5, 2018

Changes in this version

type Parser

+ CustomPrimitiveTypes map[string]string

Jun 12, 2018

Changes in this version

+ func Skip(f os.FileInfo) error

type Operation

+ HTTPMethod string

Sep 17, 2022

Changes in this version

+ const ANY

+ const ARRAY

+ const BOOLEAN

+ const CamelCase

+ const ERROR

+ const FUNC

+ const INTEGER

+ const INTERFACE

+ const IgnoreNameOverridePrefix

+ const NIL

+ const NUMBER

+ const OBJECT

+ const PRIMITIVE

+ const PascalCase

+ const STRING

+ const SnakeCase

+ const Version

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

+ 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 CheckSchemaType(typeName string) error

+ func IsGolangPrimitiveType(typeName string) bool

+ func IsInterfaceLike(typeName string) bool

+ func IsNumericType(typeName string) bool

+ func IsPrimitiveType(typeName string) bool

+ func IsSimplePrimitiveType(typeName string) bool

+ func ParseUsingGoList(enabled bool) func(parser *Parser)

+ 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 TransToValidSchemeType(typeName string) string

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

+ func TypeDocNameFuncScoped(pkgName string, spec *ast.TypeSpec, fnName string) 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

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

+ type Formatter struct

+ func NewFormatter() *Formatter

+ func (f *Formatter) Format(fileName string, contents []byte) ([]byte, 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) ParseEmptyResponseOnly(commentLine string) error

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

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

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

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

+ type PackageDefinitions struct

+ Files map[string]*ast.File

+ Name string

+ TypeDefinitions map[string]*TypeSpecDef

+ type PackagesDefinitions struct

+ func NewPackagesDefinitions() *PackagesDefinitions

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

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

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

type Parser

+ Overrides map[string]string

+ ParseDependency bool

+ ParseInternal bool

+ ParseVendor bool

+ PropNamingStrategy string

+ RequiredByDefault bool

+ Strict bool

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

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

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

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

+ func (parser *Parser) ParseDefinition(typeSpecDef *TypeSpecDef) (*Schema, error)

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

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

+ func (parser *Parser) ParseRouterAPIInfo(fileName string, astFile *ast.File) 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 Spec struct

+ BasePath string

+ Description string

+ Host string

+ InfoInstanceName string

+ Schemes []string

+ SwaggerTemplate string

+ Title string

+ Version string

+ func (i *Spec) InstanceName() string

+ func (i *Spec) ReadDoc() string

type Swagger

+ func GetSwagger(name string) Swagger

+ type TypeSpecDef struct

+ File *ast.File

+ ParentSpec ast.Decl

+ PkgPath string

+ TypeSpec *ast.TypeSpec

+ func (t *TypeSpecDef) FullName() string

+ func (t *TypeSpecDef) FullPath() string

+ func (t *TypeSpecDef) Name() string

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