go-swagger 生成接口,注解说明 (注解为参数)
// Index
// @Summary 后台登陆页
// @Tags 后台-登陆功能
// @param name formData string false "用户名"
// @param pwd formData string false "密码"
// @param keyid formData string false "验证码是对应key"
// @param base64s formData string false "验证码"
// @Success 200 {string} json{"code","message"}
// @Router /admin/login/index [POST]
swag注解说明
@Tags: 分类信息,用逗号分割多个,写多个的话,在api文档里面会生成多个接口
@Summary: 操作的简短摘要。
@Accept json
@Produce json
@Param:参数信息,用空格分隔的参数。
param name type data type is mandatory comment attribute(optional)
1.参数名,2.参数类型,3.参数数据类型,4.是否必须,5.参数描述,6.其他属性
1.参数名
参数名就是我们解释参数的名字。
2.参数类型,可以有的值是 query、path、body、header,formData
-
query 表示带在 url 之后的参数
-
path 表示请求路径上得参数
-
body 表示是一个 raw 数据请求,当Accept是JSON格式时,我们使用该字段指定接收的JSON类型
-
header 表示带在 header 信息中得参数
-
formData 表示是 post 请求的数据
3.参数数据类型
数据类型主要支持以下几种:
-
string (string)
-
integer (int, uint, uint32, uint64)
-
number (float32)
-
boolean (bool)
-
自定义struct
4.是否必须
5.参数描述
就是参数的一些说明,注释
6.其他属性
除了上面这些属性外,我们还可以为该参数填写一些额外的属性,如枚举,默认值,值范围等。
魔乐社区(Modelers.cn) 是一个中立、公益的人工智能社区,提供人工智能工具、模型、数据的托管、展示与应用协同服务,为人工智能开发及爱好者搭建开放的学习交流平台。社区通过理事会方式运作,由全产业链共同建设、共同运营、共同享有,推动国产AI生态繁荣发展。
更多推荐


所有评论(0)