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. DownloadSwagfor Go by using:

$ go get -d github /swaggo/swag/cmd/swag

#1.16 or newer
$ go install github /swaggo/swag/cmd/swag@latest

3. Run theSwagin your Go project root folder which containsmain.gofile,Swagwill parse comments and generate required files(docsfolder anddocs/doc.go).

$ swag init

4. Downloadecho-swaggerby using:

$ go get -u github /swaggo/echo-swagger

And import following in your code:

import"github /swaggo/echo-swagger"// echo-swagger middleware

Canonical example:

packagemain

import(
"github /labstack/echo/v4"
"github /swaggo/echo-swagger"

_"github /swaggo/echo-swagger/example/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:// swagger.io/support
// @contact.email [email protected]

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

// @host petstore.swagger.io
// @BasePath /v2
funcmain() {
e:=echo.New()

e.GET("/swagger/*",echoSwagger.WrapHandler)

e.Logger.Fatal(e.Start(":1323"))
}

5. Run it, and browser tohttp://localhost:1323/swagger/index.html,you can see Swagger 2.0 Api documents.

Note: If you are using Gzip middleware you should add the swagger endpoint to skipper

Example

e.Use(middleware.GzipWithConfig(middleware.GzipConfig{
Skipper: func(c echo.Context) bool {
if strings.Contains(c.Request().URL.Path, "swagger" ) {
return true
}
return false
},
}))