ginSwagger

README

gin-swagger

gin middleware to automatically generate RESTful API documentation with Swagger 2.0.

Usage

Start using it

1. Add comments to your API source code, See Declarative Comments Format.
2. Download Swag for Go by using:

$ go get -u github.com/swaggo/swag/cmd/swag

1. Run the Swag in your Go project root folder which contains main.go file, Swag will parse comments and generate required files(docs folder and docs/doc.go).

$ swag init

1. Download gin-swagger by using:

$ go get -u github.com/canecat/gin-swagger
$ go get -u github.com/swaggo/files

And import following in your code:

import "github.com/canecat/gin-swagger" // gin-swagger middleware
import "github.com/swaggo/files" // swagger embed files

Canonical example:

package main

import (
	"github.com/gin-gonic/gin"
	swaggerFiles "github.com/swaggo/files"
	"github.com/canecat/gin-swagger"
	
	_ "github.com/canecat/gin-swagger/example/basic/docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /api/v2
func main() {
	r := gin.New()

	swaggerBase := ginSwagger.SwaggerBase("/api/v2/docs/") // default `swagger/`
	specFileName := ginSwagger.SpecFileName("swagger.json") // default `doc.json`

	apiGroup := r.Group("/api/v2")
	// apiGroup.GET("/ping", api.GetPing)
	apiGroup.GET("/docs/*any", ginSwagger.WrapHandler(swaggerFiles.Handler, swaggerBase, specFileName))

	r.Run()
}

1. Run it, and browse to http://localhost:8080/api/v2/docs/, you can see Swagger 2.0 Api documents.

1. If you want to disable swagger when some environment variable is set, use DisablingWrapHandler

Example with disabling:

package main

import (
	"github.com/gin-gonic/gin"
	swaggerFiles "github.com/swaggo/files"
	"github.com/canecat/gin-swagger"
    
	_ "./docs" // docs is generated by Swag CLI, you have to import it.
)

// @title Swagger Example API
// @version 1.0
// @description This is a sample server Petstore server.
// @termsOfService http://swagger.io/terms/

// @contact.name API Support
// @contact.url http://www.swagger.io/support
// @contact.email support@swagger.io

// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html

// @host petstore.swagger.io
// @BasePath /v2
func main() {
	r := gin.New()
    
    // use ginSwagger middleware to 
	r.GET("/swagger/*any", ginSwagger.DisablingWrapHandler(swaggerFiles.Handler, "NAME_OF_ENV_VARIABLE"))

	r.Run()
}

Then, if you set envioment variable NAME_OF_ENV_VARIABLE to anything, /swagger/*any will respond 404, just like when route unspecified.

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, confs ...func(c *Config)) gin.HandlerFunc
• func Oauth2AppName(appName string) func(c *Config)
• func Oauth2ClientID(clientID string) func(c *Config)
• func SpecFileName(specFileName string) func(c *Config)
• func SwaggerBase(swaggerBase 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, confs ...func(c *Config)) gin.HandlerFunc

DisablingWrapHandler turn handler off if specified environment variable passed

func Oauth2AppName

func Oauth2AppName(appName string) func(c *Config)

Oauth2AppName sets OAuth2 application name

func Oauth2ClientID

func Oauth2ClientID(clientID string) func(c *Config)

Oauth2ClientID sets OAuth2 client ID

func SpecFileName

func SpecFileName(specFileName string) func(c *Config)

SpecFileName sets name of API definition (normally swagger.json or swagger.yaml).

func SwaggerBase

func SwaggerBase(swaggerBase string) func(c *Config)

SwaggerBase sets the subpath of swagger router. Default is `swagger/`.

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`.
	SpecFileName   string
	SwaggerBase    string
	DeepLinking    bool
	Oauth2ClientID string
	Oauth2AppName  string
}

Config stores ginSwagger configuration variables.