Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  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

echoswagger

package module

Go to main page

Versions in this module

v2

v2.1.4

Feb 16, 2021

v2.1.3

Feb 16, 2021

v2.1.2

Feb 15, 2021

v2.1.1

Feb 15, 2021

Changes in this version

+ const DefPrefix

+ const DefaultCDN

+ const SpecName

+ const SwaggerUIContent

+ const SwaggerVersion

+ type Api interface

+ AddParamBody func(p interface{}, name, desc string, required bool) Api

+ AddParamFile func(name, desc string, required bool) Api

+ AddParamForm func(p interface{}, name, desc string, required bool) Api

+ AddParamFormNested func(p interface{}) Api

+ AddParamHeader func(p interface{}, name, desc string, required bool) Api

+ AddParamHeaderNested func(p interface{}) Api

+ AddParamPath func(p interface{}, name, desc string) Api

+ AddParamPathNested func(p interface{}) Api

+ AddParamQuery func(p interface{}, name, desc string, required bool) Api

+ AddParamQueryNested func(p interface{}) Api

+ AddResponse func(code int, desc string, schema interface{}, header interface{}) Api

+ Route func() *echo.Route

+ SetDeprecated func() Api

+ SetDescription func(desc string) Api

+ SetExternalDocs func(desc, url string) Api

+ SetOperationId func(id string) Api

+ SetRequestContentType func(types ...string) Api

+ SetResponseContentType func(types ...string) Api

+ SetSecurity func(names ...string) Api

+ SetSecurityWithScope func(s map[string][]string) Api

+ SetSummary func(summary string) Api

+ type ApiGroup interface

+ EchoGroup func() *echo.Group

+ SetDescription func(desc string) ApiGroup

+ SetExternalDocs func(desc, url string) ApiGroup

+ SetSecurity func(names ...string) ApiGroup

+ SetSecurityWithScope func(s map[string][]string) ApiGroup

+ type ApiRoot interface

+ AddSecurityAPIKey func(name, desc string, in SecurityInType) ApiRoot

+ AddSecurityBasic func(name, desc string) ApiRoot

+ AddSecurityOAuth2 func(name, desc string, flow OAuth2FlowType, authorizationUrl, tokenUrl string, ...) ApiRoot

+ BindGroup func(name string, g *echo.Group) ApiGroup

+ Echo func() *echo.Echo

+ GetRaw func() *Swagger

+ Group func(name, prefix string, m ...echo.MiddlewareFunc) ApiGroup

+ SetExternalDocs func(desc, url string) ApiRoot

+ SetRaw func(s *Swagger) ApiRoot

+ SetRequestContentType func(types ...string) ApiRoot

+ SetResponseContentType func(types ...string) ApiRoot

+ SetScheme func(schemes ...string) ApiRoot

+ SetUI func(ui UISetting) ApiRoot

+ func New(e *echo.Echo, docPath string, i *Info) ApiRoot

+ type ApiRouter interface

+ Add func(method, path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ DELETE func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ GET func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ HEAD func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ OPTIONS func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ PATCH func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ POST func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ PUT func(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ type Contact struct

+ Email string

+ Name string

+ URL string

+ type ExternalDocs struct

+ Description string

+ URL string

+ type Header struct

+ CollectionFormat string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Pattern string

+ Type string

+ UniqueItems bool

+ type Info struct

+ Contact *Contact

+ Description string

+ Extensions map[string]interface{}

+ License *License

+ TermsOfService string

+ Title string

+ Version string

+ type Items struct

+ CollectionFormat string

+ Default interface{}

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Pattern string

+ Type string

+ UniqueItems bool

+ type JSONLink struct

+ Description string

+ EncType string

+ Href string

+ MediaType string

+ Method string

+ Rel string

+ Schema *JSONSchema

+ TargetSchema *JSONSchema

+ Title string

+ type JSONMedia struct

+ BinaryEncoding string

+ Type string

+ type JSONSchema struct

+ AdditionalProperties *JSONSchema

+ AnyOf []*JSONSchema

+ DefaultValue interface{}

+ Definitions map[string]*JSONSchema

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Format string

+ ID string

+ Items *JSONSchema

+ MaxLength *int

+ Maximum *float64

+ Media *JSONMedia

+ MinLength *int

+ Minimum *float64

+ Pattern string

+ Properties map[string]*JSONSchema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Schema string

+ Title string

+ Type JSONType

+ XML *XMLSchema

+ type JSONType string

+ type License struct

+ Name string

+ URL string

+ type OAuth2FlowType string

+ const OAuth2FlowAccessCode

+ const OAuth2FlowApplication

+ const OAuth2FlowImplicit

+ const OAuth2FlowPassword

+ type Operation struct

+ Consumes []string

+ Deprecated bool

+ Description string

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ OperationID string

+ Parameters []*Parameter

+ Produces []string

+ Responses map[string]*Response

+ Schemes []string

+ Security []map[string][]string

+ Summary string

+ Tags []string

+ type ParamInType string

+ const ParamInBody

+ const ParamInFormData

+ const ParamInHeader

+ const ParamInPath

+ const ParamInQuery

+ type Parameter struct

+ AllowEmptyValue bool

+ CollectionFormat string

+ Default interface{}

+ Description string

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Extensions map[string]interface{}

+ Format string

+ In string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf float64

+ Name string

+ Pattern string

+ Required bool

+ Schema *JSONSchema

+ Type string

+ UniqueItems bool

+ type Path struct

+ Delete *Operation

+ Extensions map[string]interface{}

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ type RawDefine struct

+ Schema *JSONSchema

+ Value reflect.Value

+ type RawDefineDic map[string]RawDefine

+ type Response struct

+ Description string

+ Extensions map[string]interface{}

+ Headers map[string]*Header

+ Ref string

+ Schema *JSONSchema

+ type Root struct

+ func (r *Root) Add(method, path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) AddSecurityAPIKey(name, desc string, in SecurityInType) ApiRoot

+ func (r *Root) AddSecurityBasic(name, desc string) ApiRoot

+ func (r *Root) AddSecurityOAuth2(name, desc string, flow OAuth2FlowType, authorizationUrl, tokenUrl string, ...) ApiRoot

+ func (r *Root) BindGroup(name string, g *echo.Group) ApiGroup

+ func (r *Root) DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) Echo() *echo.Echo

+ func (r *Root) GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) GetRaw() *Swagger

+ func (r *Root) GetSpec(c echo.Context, docPath string) (Swagger, error)

+ func (r *Root) Group(name, prefix string, m ...echo.MiddlewareFunc) ApiGroup

+ func (r *Root) HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) Api

+ func (r *Root) SetExternalDocs(desc, url string) ApiRoot

+ func (r *Root) SetRaw(s *Swagger) ApiRoot

+ func (r *Root) SetRequestContentType(types ...string) ApiRoot

+ func (r *Root) SetResponseContentType(types ...string) ApiRoot

+ func (r *Root) SetScheme(schemes ...string) ApiRoot

+ func (r *Root) SetUI(ui UISetting) ApiRoot

+ type Scope struct

+ Description string

+ type SecurityDefinition struct

+ AuthorizationURL string

+ Description string

+ Extensions map[string]interface{}

+ Flow string

+ In string

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ Type string

+ type SecurityInType string

+ const SecurityInHeader

+ const SecurityInQuery

+ type SecurityType string

+ const SecurityAPIKey

+ const SecurityBasic

+ const SecurityOAuth2

+ type Swagger struct

+ BasePath string

+ Consumes []string

+ Definitions map[string]*JSONSchema

+ ExternalDocs *ExternalDocs

+ Host string

+ Info *Info

+ Parameters map[string]*Parameter

+ Paths map[string]interface{}

+ Produces []string

+ Responses map[string]*Response

+ Schemes []string

+ SecurityDefinitions map[string]*SecurityDefinition

+ Swagger string

+ Tags []*Tag

+ type Tag struct

+ Description string

+ Extensions map[string]interface{}

+ ExternalDocs *ExternalDocs

+ Name string

+ type UISetting struct

+ CDN string

+ DetachSpec bool

+ HideTop bool

+ type XMLSchema struct

+ Attribute string

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

Other modules containing this package

github.com/rsrdesarrollo/echoswagger