@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 "用户姓名"
有疑问加站长微信联系(非本文作者)