ginSwagger

README

gin-swagger

功能同 https://github.com/swaggo/gin-swagger 修复以下问题

• set preifx data race

Documentation

Index

• func CustomWrapHandler(config *Config, h *webdav.Handler) gin.HandlerFunc
• func DeepLinking(deepLinking bool) func(c *Config)
• func DisablingCustomWrapHandler(config *Config, h *webdav.Handler, envName string) gin.HandlerFunc
• func DisablingWrapHandler(h *webdav.Handler, envName string) gin.HandlerFunc
• func URL(url string) func(c *Config)
• func WrapHandler(h *webdav.Handler, confs ...func(c *Config)) gin.HandlerFunc
• type Config

Functions

func CustomWrapHandler

func CustomWrapHandler(config *Config, h *webdav.Handler) gin.HandlerFunc

CustomWrapHandler wraps `http.Handler` into `gin.HandlerFunc`

func DeepLinking

func DeepLinking(deepLinking bool) func(c *Config)

DeepLinking set the swagger deeplinking configuration

func DisablingCustomWrapHandler

func DisablingCustomWrapHandler(config *Config, h *webdav.Handler, envName string) gin.HandlerFunc

DisablingCustomWrapHandler turn handler off if specified environment variable passed

func DisablingWrapHandler

func DisablingWrapHandler(h *webdav.Handler, envName string) gin.HandlerFunc

DisablingWrapHandler turn handler off if specified environment variable passed

func URL

func URL(url string) func(c *Config)

URL presents the url pointing to API definition (normally swagger.json or swagger.yaml).

func WrapHandler

func WrapHandler(h *webdav.Handler, confs ...func(c *Config)) gin.HandlerFunc

WrapHandler wraps `http.Handler` into `gin.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
	DeepLinking bool
}

Config stores ginSwagger configuration variables.