ginSwagger

package module

v1.2.1 Latest Latest Go to latest Published: Aug 4, 2020 License: MIT Imports: 8 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/lewisay/gin-swagger

Links

Open Source Insights

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

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func CustomWrapHandler ¶ added in v1.2.1

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

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

func DeepLinking ¶ added in v1.2.1

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

DeepLinking set the swagger deeplinking configuration

func DisablingCustomWrapHandler ¶ added in v1.2.1

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

DisablingCustomWrapHandler turn handler off if specified environment variable passed

func DisablingWrapHandler ¶ added in v1.2.1

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

DisablingWrapHandler turn handler off if specified environment variable passed

func URL ¶ added in v1.2.1

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 ¶ added in v1.2.1

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.

Source Files ¶

View all Source files

swagger.go

Directories ¶

Path	Synopsis
example
basic
basic/api
basic/docs
basic/web
gzipped

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL