Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
View Source
var DefaultOptions = Options{ Title: "Default Title", Version: "1.0", Servers: []ServerDoc{ {"https://www.example.com/v3", "Production environment API"}, {"https://test.example.com/v3", "Test environment API"}, }, }
Functions ¶
func DecodeParams ¶
Types ¶
type Route ¶
type Route struct {
Path string
Methods []string
RequestBody interface{}
ResponseBody interface{}
Parameters interface{}
// Middlewares are route level middlewares executed for this particular route only
Middlewares []func(http.Handler) http.Handler
Handler http.Handler
// Short summary
Summary string
// Optional description. Should use CommonMark syntax
Description string
}
Route collects all the information for handler and documentation generator.
The router matches the handler based on defined Path and Methods only.
Click to show internal directories.
Click to hide internal directories.