echoswagger

README

echo-swagger

echo 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

4.Download echo-swagger by using:

$ go get -u github.com/lyfunny/echo-swagger

And import following in your code:

import "github.com/lyfunny/echo-swagger" // echo-swagger middleware
import "github.com/lyfunny/echo-swagger/swaggerFiles" // swagger embed files

Canonical example:

package main

import (
	"github.com/labstack/echo/v4"
	echoswagger "github.com/lyfunny/echo-swagger"
	"github.com/lyfunny/echo-swagger/swaggerFiles"

	_ "yourpath/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 := echo.New()

	url := echoswagger.URL("http://localhost:8080/swagger/doc.json") //The url pointing to API definition
	r.GET("/swagger/*", echoswagger.WrapHandler(swaggerFiles.Handler, url))

	r.Start(":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/labstack/echo/v4"
	echoswagger "github.com/lyfunny/echo-swagger"
	"github.com/lyfunny/echo-swagger/swaggerFiles"
)

// @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 := echo.New()
    
    // use echoswagger middleware to 
	r.GET("/swagger/*any", echoswagger.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) echo.HandlerFunc
• func DisablingCustomWrapHandler(config *Config, h *webdav.Handler, envName string) echo.HandlerFunc
• func DisablingWrapHandler(h *webdav.Handler, envName string) echo.HandlerFunc
• func URL(url string) func(c *Config)
• func WrapHandler(h *webdav.Handler, confs ...func(c *Config)) echo.HandlerFunc
• type Config

Functions

func CustomWrapHandler

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

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

func DisablingCustomWrapHandler

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

DisablingCustomWrapHandler turn handler off if specified environment variable passed

func DisablingWrapHandler

func DisablingWrapHandler(h *webdav.Handler, envName string) echo.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)) echo.HandlerFunc

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

Config stores echoSwagger configuration variables.