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

docs

package module

Go to main page

Versions in this module

v1

v1.1.0

Mar 15, 2023

Changes in this version

type OAS

+ func (oas *OAS) AddRoute(path *Path)

+ func (oas *OAS) BuildStream(w io.Writer) error

+ type Parameter struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema Schema

+ type Parameters []Parameter

type Path

+ Description string

+ Parameters Parameters

v1.0.7

Mar 6, 2021

v1.0.6

Mar 6, 2021

v1.0.5

Feb 4, 2021

v1.0.4

Feb 4, 2021

v1.0.3

Feb 4, 2021

Changes in this version

+ type RouteFn func(index int, oas *OAS)

v1.0.2

Feb 4, 2021

v1.0.1

Feb 3, 2021

v1.0.0

Feb 3, 2021

Changes in this version

+ const OASAnnotationInit

+ func ServeSwaggerUI(conf *ConfigSwaggerUI) error

+ type Component struct

+ Schemas Schemas

+ SecuritySchemes SecuritySchemes

+ type Components []Component

+ type ConfigBuilder struct

+ CustomPath string

+ type ConfigSwaggerUI struct

+ Port string

+ Route string

+ type Contact struct

+ Email string

+ type ContentType struct

+ Name string

+ Schema string

+ type ContentTypes []ContentType

+ type ExternalDocs struct

+ Description string

+ URL URL

+ type Info struct

+ Contact Contact

+ Description string

+ License License

+ TermsOfService URL

+ Title string

+ Version Version

+ func (i *Info) SetContact(email string)

+ func (i *Info) SetLicense(licType, url string)

+ type License struct

+ Name string

+ URL URL

+ type OAS struct

+ Components Components

+ ExternalDocs ExternalDocs

+ Info Info

+ OASVersion OASVersion

+ Paths Paths

+ RegisteredRoutes RegRoutes

+ Servers Servers

+ Tags Tags

+ func New() OAS

+ func (o *OAS) AttachRoutes(fns []interface{})

+ func (o *OAS) BuildDocs(conf ...ConfigBuilder) error

+ func (o *OAS) Call(name string, params ...interface{}) (result []reflect.Value, err error)

+ func (o *OAS) GetInfo() *Info

+ func (o *OAS) GetPathByIndex(index int) *Path

+ func (o *OAS) GetRegisteredRoutes() RegRoutes

+ func (o *OAS) MapAnnotationsInPath(scanIn string, conf ...configAnnotation) error

+ func (o *OAS) SetOASVersion(ver string)

+ type OASVersion Version

+ type Path struct

+ HTTPMethod string

+ HandlerFuncName string

+ OperationID string

+ RequestBody RequestBody

+ Responses Responses

+ Route string

+ Security SecurityEntities

+ Summary string

+ Tags []string

+ type Paths []Path

+ type RegRoutes map[string]interface

+ type RequestBody struct

+ Content ContentTypes

+ Description string

+ Required bool

+ type Response struct

+ Code uint

+ Content ContentTypes

+ Description string

+ type Responses []Response

+ type Schema struct

+ Name string

+ Properties SchemaProperties

+ Ref string

+ Type string

+ XML XMLEntry

+ type SchemaProperties []SchemaProperty

+ type SchemaProperty struct

+ Default interface{}

+ Description string

+ Enum []string

+ Format string

+ Name string

+ Type string

+ type Schemas []Schema

+ type Security struct

+ AuthName string

+ PermTypes []string

+ type SecurityEntities []Security

+ type SecurityFlow struct

+ AuthURL URL

+ Scopes SecurityScopes

+ Type string

+ type SecurityFlows []SecurityFlow

+ type SecurityScheme struct

+ Flows SecurityFlows

+ In string

+ Name string

+ Type string

+ type SecuritySchemes []SecurityScheme

+ type SecurityScope struct

+ Description string

+ Name string

+ type SecurityScopes []SecurityScope

+ type Server struct

+ URL URL

+ type Servers []Server

+ type Tag struct

+ Description string

+ ExternalDocs ExternalDocs

+ Name string

+ type Tags []Tag

+ func (tt *Tags) AppendTag(tag *Tag)

+ func (tt *Tags) SetTag(name, tagDescription string, extDocs ExternalDocs)

+ type URL string

+ type Version string

+ type XMLEntry struct

+ Name string