golang的swagger注解

Lan_de · · 4197 次点击 · · 开始浏览    
这是一个创建于 的文章,其中的信息可能已经有所发展或是发生改变。

@Tags: 分类信息
例如:

// @Tags 用户接口

@Summary: 操作的简短摘要。
例如:

//@Summary 通过用户名得到用户信息

@Description: 操作的详细说明。
例如:

//@Description 操作行为的详细说明。

@Param:参数信息,用空格分隔的参数。param name,param type,data type,is mandatory?,comment attribute(optional)
1.参数名
2.参数类型,可以有的值是 formData、query、path、body、header,formData 表示是 post 请求的数据,query 表示带在 url 之后的参数,path 表示请求路径上得参数,例如上面例子里面的 key,body 表示是一个 raw 数据请求,header 表示带在 header 信息中得参数。
3.参数类型
4.是否必须
5.注释
例如:

// @Param name query string true "用户姓名"

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

本文来自:简书

感谢作者:Lan_de

查看原文:golang的swagger注解

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

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