Documentation ¶
Index ¶
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EchoHandleFunc ¶
func EchoHandleFunc(specURL string, opts ...ParameterOption) echo.HandlerFunc
EchoHandleFunc returns echo.HandleFunc
Example ¶
e := echo.New() e.GET("/docs", EchoHandleFunc("/docs/spec", WithTitle("Example"))) if err := e.Server.ListenAndServe(); err != nil { panic(err) }
Output:
func HTTPHandleFunc ¶
func HTTPHandleFunc(specURL string, opts ...ParameterOption) http.HandlerFunc
HTTPHandleFunc returns http.HandlerFunc
Example ¶
if err := http.ListenAndServe(":1202", HTTPHandleFunc("http://localhost:1324/docs/spec")); err != nil { panic(err) }
Output:
Types ¶
type Parameter ¶
type Parameter struct { Title string `json:"title,omitempty"` Favicon string `json:"favicon,omitempty"` SpecURL string `json:"spec_url,omitempty"` }
Parameter is golang template parameter
type ParameterOption ¶
type ParameterOption func(*Parameter)
ParameterOption sets Parameter fields
func WithFavicon ¶
func WithFavicon(favicon string) ParameterOption
WithFavicon sets favicon url to Parameter.Favicon
func WithTitle ¶
func WithTitle(title string) ParameterOption
WithTitle sets title to Parameter.Title
Click to show internal directories.
Click to hide internal directories.