Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

swag

package module

Go to main page

Versions in this module

v1

v1.8.0

Jan 31, 2022

v1.7.3

Dec 2, 2020

Changes in this version

+ const CamelCase

+ const PascalCase

+ const SnakeCase

+ const Version

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

+ func CheckSchemaType(typeName string) error

+ func IsGolangPrimitiveType(typeName string) bool

+ func IsNumericType(typeName string) bool

+ func IsPrimitiveType(typeName string) bool

+ func IsSimplePrimitiveType(typeName string) bool

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

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

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

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

+ func TransToValidCollectionFormat(format string) string

+ func TransToValidSchemeType(typeName string) string

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

type Operation

+ HTTPMethod string

+ 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) ParseRequestStructure(commentLine string, astFile *ast.File) error

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

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

type Parser

+ CustomPrimitiveTypes map[string]string

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

+ ParseDependency bool

+ ParseInternal bool

+ ParseVendor bool

+ PropNamingStrategy string

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

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

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

+ func (parser *Parser) ParseRouterAPIInfo(fileName string, astFile *ast.File) error

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

v1.1.0

Feb 4, 2018

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

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

+ 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

Other modules containing this package

github.com/mymdz/swag/v2