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

summerfish

package module

Go to main page

Versions in this module

v1

v1.4.2

Nov 25, 2020

Changes in this version

type RouteHolder

+ ID int

type RouteParser

+ ID int

+ IsOnlyEndpointParser bool

type RouteParserHolder

+ ID int

+ type RoutePath struct

+ FullPath string

+ LineNumber int

+ RelativePath string

v1.4.1

Nov 24, 2020

Changes in this version

type InputParameter

+ Required bool

type NameType

+ IsRequired bool

v1.4.0

Nov 20, 2020

Changes in this version

type Operation

+ Consumes []string

+ type OperationResponse struct

+ Description string

+ type RouteParserHolder struct

type SchemeHolder

+ Information SchemeInformation

+ func (s *SchemeHolder) GenerateSwaggerJson(routes []RouteHolder, filePath string) (err error)

+ func (s *SchemeHolder) GenerateSwaggerYaml(routes []RouteHolder, filePath string) (err error)

+ type SchemeInformation struct

+ Title string

+ Version string

v1.3.3

Sep 3, 2019

v1.3.2

Sep 3, 2019

Changes in this version

type RouteHolder

+ FormData []NameType

v1.3.1

May 2, 2019

v1.3.0

May 2, 2019

v1.2.2

Feb 28, 2019

Changes in this version

+ const SwaggerFileRoute

+ const SwaggerUIRoute

+ func AddSwaggerUIEndpoints(router *mux.Router, config Config) (err error)

+ func RemoveCommentSection(line string) (string, bool)

+ type Config struct

+ BaseRoute string

+ Schemes []string

+ SwaggerFileHeaderRoute string

+ SwaggerFilePath string

+ SwaggerFileRoute string

+ SwaggerUIRoute string

+ type InputParameter struct

+ Description string

+ GoName string

+ Name string

+ QueryType string

+ Schema SchemaParameters

+ Type string

+ type Method map[string]Operation

+ type NameType struct

+ Children []NameType

+ IsArray bool

+ Name string

+ Type string

+ type Operation struct

+ ID string

+ Parameters []InputParameter

+ Responses map[string]string

+ Summary string

+ Tags []string

+ type PathsHolder map[string]Method

+ type RouteHolder struct

+ Body NameType

+ Methods []string

+ Name string

+ Path []NameType

+ Query []NameType

+ Route string

+ func GetInfoFromRouter(r *mux.Router) (holders []RouteHolder, err error)

+ type RouteParser struct

+ FullPath string

+ LineNumber int

+ Methods []string

+ RelativePath string

+ Route string

+ type SchemaParameters struct

+ Items *SchemaParameters

+ Properties map[string]SchemaParameters

+ Type string

+ type SchemeHolder struct

+ BasePath string

+ Host string

+ Paths PathsHolder

+ Schemes []string

+ SwaggerVersion string

+ func (s *SchemeHolder) GenerateSwaggerFile(routes []RouteHolder, filePath string) (err error)