Swagger生成文档问题

__Golang__ · 2021-03-29 10:26:32 · 4387 次点击 · 大约8小时之前 开始浏览    置顶
这是一个创建于 2021-03-29 10:26:32 的主题,其中的信息可能已经有所发展或是发生改变。

//@Summary get user by user_id
//@Param id path int false
//@Router /api/v1/user/{id} [get]
func (u User)Get(c *gin.Context){}

swag 初始化时报错 ,但是我看Go 语言编程之旅 入参也只有*gin.Context,不知道它怎么成功初始化的 https://golang2.eddycjy.com/posts/ch2/04-api-doc/

*******>swag init
2021/03/29 10:21:00 Generate swagger docs....
2021/03/29 10:21:00 Generate general API Info, search dir:./
2021/03/29 10:21:00 ParseComment error in file internal\model\user.go :missing required param comment parameters "id path int false"

有疑问加站长微信联系(非本文作者)

入群交流(和以上内容无关):加入Go大咖交流群,或添加微信:liuxiaoyan-s 备注:入群;或加QQ群:692541889

4387 次点击  ∙  1 赞  
加入收藏 微博
2 回复  |  直到 2021-03-30 20:45:22
Leizhengzi
Leizhengzi · #1 · 4年之前

需要添加comment,即字段描述 //@Param id path int false "ID描述" swagger它的参数语法: @Param [param name] [paramType] [data type] [is required?] [comment]

__Golang__
__Golang__ · #2 · 4年之前
LeizhengziLeizhengzi #1 回复

需要添加comment,即字段描述 //@Param id path int false "ID描述" swagger它的参数语法: @Param [param name] [paramType] [data type] [is required?] [comment]

感谢,还以为是可选字段

添加一条新回复 (您需要 登录 后才能回复 没有账号 ?)
  • 请尽量让自己的回复能够对别人有帮助
  • 支持 Markdown 格式, **粗体**、~~删除线~~、`单行代码`
  • 支持 @ 本站用户;支持表情(输入 : 提示),见 Emoji cheat sheet
  • 图片支持拖拽、截图粘贴等方式上传