记一次gin中使用swagger的方法

在 Go 语言中,我们可以使用 swaggo/swag 库来为 API 生成 Swagger 文档。下面是一个简单的步骤:

  1. 安装 swaggo/swag 库:
    go get -u github.com/swaggo/swag/cmd/swag
    
  2. 在 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) {
        // ...
    }
    

  3. 运行 swag init 命令来生成 Swagger 文档:
    swag init
    

  4. 在 main 函数中使用 Swagger 中间件:
    import "github.com/swaggo/gin-swagger"
    
    // ...
    
    router := gin.New()
    
    // 注册 Swagger 中间件
    router.GET("/swagger/*any", ginSwagger.WrapHandler(swaggerFiles.Handler))
    
    // ...
    

  5. 启动服务并访问 Swagger 文档:
    go run main.go
    

  6. 启动浏览器输入地址,你可以在 Swagger UI 中看到所有的 API 文档和操作的详细信息。这使得你可以很方便地测试和使用你的 API。PS.登陆地址为:http://127.0.0.1:8080/swagger/index.html,不过不带后面index.html则会报错

 

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值