iris-swagger
iris handler to automatically generate RESTful API documentation with Swagger 2.0.
Usage
Start using it
- Add comments to your API source code, See Declarative Comments Format.
- Download Swag for Go by using:
$ go get -u github.com/swaggo/swag/cmd/swag
- 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
- Download iris-swagger by using:
$ go get -u github.com/swaggo/iris-swagger
$ go get -u github.com/swaggo/files
And import following in your code:
import(
swaggerFiles "github.com/swaggo/files"
irisSwagger "github.com/daqiancode/iris-swagger"
)
app.Get("/swagger/{swaggerPath:path}", irisSwagger.WrapHandler(swaggerFiles.Handler))
Canonical example:
package main
import (
"github.com/kataras/iris/v12"
swaggerFiles "github.com/swaggo/files"
irisSwagger "github.com/daqiancode/iris-swagger"
_ "projectName/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()
app.Get("/swagger/{swaggerPath:path}", irisSwagger.WrapHandler(swaggerFiles.Handler))
app.Listen(":8080")
}
- Run it, and browse to http://localhost:8080/swagger/index.html, you can see Swagger 2.0 Api documents.
- 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"
swaggerFiles "github.com/swaggo/files"
irisSwagger "github.com/daqiancode/iris-swagger"
_ "projectName/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 irisSwagger middleware to
r.Get("/swagger/{path:path}", irisSwagger.DisablingWrapHandler(swaggerFiles.Handler, "NAME_OF_ENV_VARIABLE"))
r.Run()
}
Then, if you set environment variable NAME_OF_ENV_VARIABLE
to anything, /swagger/{path:path}
will respond 404, just like when route unspecified.