Skip to content
echo middleware to automatically generate RESTful API documentation with Swagger 2.0.
Go
Branch: master
Clone or download
pei0804 Merge pull request #13 from swaggo/add-config-to-wraphandler
feat: add EchoWrapHandler func with configurations
Latest commit 1219b46 Mar 29, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
example
.travis.yml
LICENSE
README.md
go.mod
go.sum
swagger.go
swagger_test.go

README.md

echo-swagger

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

Travis branch Codecov branch Go Report Card

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 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 echo-swagger by using:
$ go get -u github.com/swaggo/echo-swagger

And import following in your code:

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

Canonical example:

package main

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

	_ "github.com/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://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() {
	e := echo.New()

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

	e.Logger.Fatal(e.Start(":1323"))
}
  1. Run it, and browser to http://localhost:1323/swagger/index.html, you can see Swagger 2.0 Api documents.

swagger_index.html

You can’t perform that action at this time.