在 Go 语言中,我们可以使用 swaggo/swag
库来为 API 生成 Swagger 文档。下面是一个简单的步骤:
- 安装
swaggo/swag
库:go get -u github.com/swaggo/swag/cmd/swag
- 在 Go 代码中编写 Swagger 注释:
// 注释必须以 // @ 开头 // @Summary 获取用户信息 // @Description 根据用户 ID 获取用户信息 // @Tags users // @Accept json // @Produce json // @Param id path int true "用户 ID" // @Success 200 {object} UserResponse // @Failure 400 {object} ErrorResponse // @Router /users/{id} [get] func getUser(c *gin.Context) { // ... }
- 运行
swag init
命令来生成 Swagger 文档:swag init
- 在 main 函数中使用 Swagger 中间件:
import "github.com/swaggo/gin-swagger" // ... router := gin.New() // 注册 Swagger 中间件 router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler)) // ...
- 启动服务并访问 Swagger 文档:
go run main.go
- 启动浏览器输入地址,你可以在 Swagger UI 中看到所有的 API 文档和操作的详细信息。这使得你可以很方便地测试和使用你的 API。PS.登陆地址为:http://127.0.0.1:8080/swagger/index.html,不过不带后面index.html则会报错