beego注解路由的格式

原文： https://blog.csdn.net/weixin_33743880/article/details/88016192

beego注解路由的注释，我们可以把我们的注释分为以下类别：

@Title

接口的标题，用来标示唯一性，唯一，可选

格式：之后跟一个描述字符串

@Description

接口的作用，用来描述接口的用途，唯一，可选

格式：之后跟一个描述字符串

@Param

    请求的参数，用来描述接受的参数，多个，可选

    格式：变量名 传输类型 类型 是否必须 描述

        变量名和描述是一个字符串

        传输类型：path，query，body, header

            query 表示带在url串里面?aa=bb&cc=dd

            form 表示使用表单递交数据

            path 表示URL串中得字符，例如/user/{uid} 那么uid就是一个path类型的参数

            body 表示使用raw body进行数据的传输

            header 表示通过header进行数据的传输

        类型：

            string

            int

            int64

            对象，这个地方大家写的时候需要注意，需要是相对于当前项目的路径.对象，例如models.Object表示models目录下的Object对象，这样bee在生成文档的时候会去扫描改对象并显示给用户改对象。

        是否必须：true 或者false

@Success

成功返回的code和对象或者信息

格式：code 对象类型 信息或者对象路径

    code：表示HTTP的标准status code，200 201等

    对象类型：{object}表示对象，其他默认都认为是字符类型，会显示第三个参数给用户，如果是{object}类型，那么就会去扫描改对象，并显示给用户

    对象路径和上面Param中得对象类型一样，使用路径.对象的方式来描述

@Failure

错误返回的信息，

格式： code 信息

    code:同上Success

    错误信息：字符串描述信息

@router

上面已经描述过支持两个参数，第一个是路由，第二个表示支持的HTTP方法

举个栗子

// @Title /bills

// @Description 返回全量费用数据

// @Param beginTime query string false "beginTime"

// @Param endTime query string false "endTime"

// @Param limit query int false "限制一次返回的数据条目"

// @Param offset query int false "偏移量"

// @Success 200 {object} models.AllBillInfo

// @Failure 404 wrong params

// @router / [get]