beego注解路由的注释,我们可以把我们的注释分为以下类别:
-
@Title
接口的标题,用来标示唯一性,唯一,可选
格式:之后跟一个描述字符串
-
@Description
接口的作用,用来描述接口的用途,唯一,可选
格式:之后跟一个描述字符串
-
请求的参数,用来描述接受的参数,多个,可选
格式:变量名 传输类型 类型 是否必须 描述
传输类型:paht or body
类型:
变量名和描述是一个字符串
是否必须:true 或者false
-
- string
- int
- int64
- 对象,这个地方大家写的时候需要注意,需要是相对于当前项目的路径.对象,例如
models.Object
表示models
目录下的Object对象,这样bee在生成文档的时候会去扫描改对象并显示给用户改对象。 - query 表示带在url串里面?aa=bb&cc=dd
- form 表示使用表单递交数据
- path 表示URL串中得字符,例如/user/{uid} 那么uid就是一个path类型的参数
- body 表示使用raw body进行