golang 引入swagger(iris、gin)
在Go中使用Swagger需要使用Swagger 2.0规范来描述API。可以使用swag
工具自动生成Swagger文档。以下是一个使用iris
框架和swag
的例子:
首先,安装swag
工具:
go get -u github.com/swaggo/swag/cmd
确保你的项目中已经安装了iris
框架:
go get -u github.com/kataras/iris
然后,安装swag
的iris中间件:
go get -u github.com/swaggo/iris
接下来,定义你的API以及它们的Swagger注释。例如:
package main
import (
"github.com/kataras/iris"
"github.com/swaggo/files"
"github.com/swaggo/iris/swagger"
)
// @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() {
iris.Get("/swagger", swagger.WrapHandler(swagger.URL("http://localhost:8080/swagger/swagger.json")))
iris.Listen(":8080")
}
在你的代码中添加注释,并且运行swag init
来生成Swagger文档:
swag init -g main.go
这将会在你的项目目录下创建一个docs
文件夹,里面包含了Swagger的JSON和HTML文件。
最后,在你的iris
服务中加入Swagger中间件,以便可以在浏览器中查看和测试你的API:
iris.Get("/swagger", swagger.WrapHandler(swagger.URL("http://localhost:8080/swagger/swagger.json")))
现在,当你运行你的服务并访问http://localhost:8080/swagger/
时,你应该能够看到Swagger UI,它展示了你的API文档。
评论已关闭