README
¶
hertz-swagger
Hertz middleware to automatically generate RESTful API documentation with Swagger 2.0.
This repo has been moved into hertz-contrib
Documentation
¶
Index ¶
- func CustomWrapHandler(config *Config, handler *webdav.Handler) app.HandlerFunc
- func DeepLinking(deepLinking bool) func(*Config)
- func DefaultModelsExpandDepth(depth int) func(*Config)
- func DocExpansion(docExpansion string) func(*Config)
- func InstanceName(name string) func(*Config)
- func Oauth2DefaultClientID(oauth2DefaultClientID string) func(*Config)
- func PersistAuthorization(persistAuthorization bool) func(*Config)
- func URL(url string) func(*Config)
- func WrapHandler(handler *webdav.Handler, options ...func(*Config)) app.HandlerFunc
- type Config
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CustomWrapHandler ¶
func CustomWrapHandler(config *Config, handler *webdav.Handler) app.HandlerFunc
CustomWrapHandler wraps `http.Handler` into `app.HandlerFunc`.
func DeepLinking ¶
DeepLinking set the swagger deep linking configuration.
func DefaultModelsExpandDepth ¶
DefaultModelsExpandDepth set the default expansion depth for models (set to -1 completely hide the models).
func DocExpansion ¶
DocExpansion list, full, none.
func InstanceName ¶
InstanceName set the instance name that was used to generate the swagger documents Defaults to swag.Name ("swagger").
func Oauth2DefaultClientID ¶
Oauth2DefaultClientID set the default client ID used for OAuth2
func PersistAuthorization ¶
PersistAuthorization Persist authorization information over browser close/refresh. Defaults to false.
func WrapHandler ¶
func WrapHandler(handler *webdav.Handler, options ...func(*Config)) app.HandlerFunc
WrapHandler wraps `http.Handler` into `app.HandlerFunc`.
Types ¶
type Config ¶
type Config struct {
// The url pointing to API definition (normally swagger.json or swagger.yaml). Default is `doc.json`.
URL string
DocExpansion string
InstanceName string
Title string
DefaultModelsExpandDepth int
DeepLinking bool
PersistAuthorization bool
Oauth2DefaultClientID string
}
Config stores hertzSwagger configuration variables.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
example
|
|
|
basic/docs
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag
|
Package docs GENERATED BY SWAG; DO NOT EDIT This file was generated by swaggo/swag |