swagger

README

Swagger for the Iris web framework

Iris middleware to automatically generate RESTful API documentation with Swagger 2.0. Based on the gin-swagger as requested at #1231.

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 swagger for Iris by using:

$ go get github.com/iris-contrib/swagger/v12@latest

And import following in your code:

import "github.com/iris-contrib/swagger/v12" // swagger middleware for Iris 
import "github.com/iris-contrib/swagger/v12/swaggerFiles" // swagger embed files

Canonical example:

package main

import (
    "github.com/kataras/iris/v12"

    "github.com/iris-contrib/swagger/v12"
    "github.com/iris-contrib/swagger/v12/swaggerFiles"

    _ "./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() {
    app := iris.New()

    config := &swagger.Config{
        URL: "http://localhost:8080/swagger/doc.json", //The url pointing to API definition
    }
    // use swagger middleware to 
    app.Get("/swagger/{any:path}", swagger.CustomWrapHandler(config, swaggerFiles.Handler))

    app.Run(iris.Addr(":8080"))
}

1. Run it, and browser to http://localhost:8080/swagger/index.html, 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/kataras/iris/v12"

    "github.com/iris-contrib/swagger/v12"
    "github.com/iris-contrib/swagger/v12/swaggerFiles"

    _ "./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() {
    app := iris.New()

    // use swagger middleware to 
    app.Get("/swagger/{any:path}", swagger.DisablingWrapHandler(swaggerFiles.Handler, "NAME_OF_ENV_VARIABLE"))

    app.Run(iris.Addr(":8080"))
}

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) iris.Handler
• func DeepLinking(deepLinking bool) func(c *Config)
• func DisablingCustomWrapHandler(config *Config, h *webdav.Handler, envName string) iris.Handler
• func DisablingWrapHandler(h *webdav.Handler, envName string) iris.Handler
• func URL(url string) func(c *Config)
• func WrapHandler(h *webdav.Handler, confs ...func(c *Config)) iris.Handler
• type Config

Functions

func CustomWrapHandler

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

CustomWrapHandler wraps `http.Handler` into `iris.Handler`

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) iris.Handler

DisablingCustomWrapHandler turn handler off if specified environment variable passed

func DisablingWrapHandler

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

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)) iris.Handler

WrapHandler wraps `http.Handler` into `iris.Handler`.

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 swagger configuration variables.