swaggo使用demo

  1. 安装Swaggo

首先需要安装Swaggo,可以使用以下命令进行安装:

go get -u github.com/swaggo/swag/cmd/swag
  1. 初始化Swaggo

在项目根目录下执行以下命令,初始化Swaggo:

swag init

执行完毕后,将会在项目根目录下生成docs目录和docs/swagger.json文件。

  1. 添加注解

在API接口方法的注释中添加注解,示例如下:

// @Summary 获取用户信息
// @Description 根据用户ID获取用户信息
// @Tags 用户信息
// @Accept json
// @Produce json
// @Param id path int true "用户ID"
// @Success 200 {object} UserResponse
// @Router /user/{id} [get]
func GetUser(ctx *gin.Context) {
    // 处理逻辑
}

括请求方法、请求路径等。

  1. 生成文档

在项目根目录下执行以下命令,生成API接口文档:

swag init -g main.go

执行完毕后,将会在docs目录下生成swagger.json和index.html文件。打开index.html文件即可查看API接口文档。

以上就是Swaggo注解的详细使用示例,希望对你有所帮助!如果你想了解更多Swaggo的用法,可以参考Swaggo官方文档。

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

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

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

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

zhangkaixuan456

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付:¥1
获取中
扫码支付

您的余额不足,请更换扫码支付或充值

打赏作者

实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

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

余额充值