swagger

Apr 17, 2023

Changes in this version

type Definitions

+ Deprecated bool

+ Description string

+ Extensions map[string]interface{}

+ Security SecurityRequirements

+ Summary string

+ type SecurityRequirement map[string][]string

+ type SecurityRequirements []SecurityRequirement

Dec 22, 2022

Changes in this version

type Router

+ func (r Router[_, _]) GenerateAndExposeOpenapi() error

Nov 4, 2022

Changes in this version

type Definitions

+ Tags []string

Aug 5, 2022

Changes in this version

+ type Parameter struct

+ Content Content

+ Description string

+ Schema *Schema

Nov 10, 2021

Changes in this version

type Options

+ PathPrefix string

type Router

+ func (r Router) SubRouter(router apirouter.Router, opts SubRouterOptions) (*Router, error)

+ type SubRouterOptions struct

+ PathPrefix string

Feb 7, 2021

Changes in this version

+ const DefaultJSONDocumentationPath

+ const DefaultYAMLDocumentationPath

+ var ErrGenerateSwagger = errors.New("fail to generate swagger")

+ var ErrPathParams = errors.New("errors generating path parameters schema")

+ var ErrQuerystring = errors.New("errors generating querystring schema")

+ var ErrRequestBody = errors.New("errors generating request body schema")

+ var ErrResponses = errors.New("errors generating responses schema")

+ var ErrValidatingSwagger = errors.New("fails to validate swagger")

+ type Content map[string]Schema

+ type ContentValue struct

+ Content Content

+ Description string

+ type Definitions struct

+ Cookies ParameterValue

+ Headers ParameterValue

+ PathParams ParameterValue

+ Querystring ParameterValue

+ RequestBody *ContentValue

+ Responses map[int]ContentValue

+ type Handler func(w http.ResponseWriter, req *http.Request)

+ type Operation struct

+ func NewOperation() Operation

+ func (o *Operation) AddRequestBody(requestBody *openapi3.RequestBody)

+ func (o *Operation) AddResponse(status int, response *openapi3.Response)

+ type Options struct

+ Context context.Context

+ JSONDocumentationPath string

+ Openapi *openapi3.Swagger

+ YAMLDocumentationPath string

+ type ParameterValue map[string]struct

+ type Router struct

+ func NewRouter(router *mux.Router, options Options) (*Router, error)

+ func (r Router) AddRawRoute(method string, path string, handler Handler, operation Operation) (*mux.Route, error)

+ func (r Router) AddRoute(method string, path string, handler Handler, schema Definitions) (*mux.Route, error)

+ func (r Router) GenerateAndExposeSwagger() error

+ type Schema struct

+ AllowAdditionalProperties bool

+ Value interface{}