Beego API自动化文档

• routers > router.go

func init() {
    ns := beego.NewNamespace("/app",
        beego.NSNamespace("/模块",
            beego.NSInclude(
                &controllers.MyController{},
            ),
        ),
    )
    beego.AddNamespace(ns)
}

• models > request.go > 接收结构体

type ReqStruct struct {
    BaseRequest
    ...         `description:"描述"`
}

• models > ...

type MyStruct struct {
    ...         `description:"描述"`
}

func Function (interface{}) (interface{}) {
    o := orm.NewOrm()
    o.Using("...")
    ...
    return 
}

• models > response.go > 返回结构体

type RespStruct struct {
    BaseResp
    MyStruct
    ...         `description:"描述"`
}

• controllers > ...

type MyController struct {
    AppBaseController
}

// @Title   标题
// @Description 描述
// @Param   body    body    models.接受结构体   true
// @Success 200 {object}    models.返回结构体   请求成功
// @Failure 304 请求失败
// @router  /功能   [post]
func (this *MyController) Method() {
    req := models.ReqStruct{}
    resp := models.RespStruct{}
    json.Unmarshal(this.Ctx.Input.RequestBody, &req)
    defer this.ServeJSON()
    var err error
    // models.Function()
    if err != nil {
        resp.RetCode = 304
        resp.RetMsg = "请求失败"
        this.Data["json"] = resp
        return
    }
    resp.RetCode = 200
    resp.RetMsg = "返回成功"
    this.Data["json"] = resp
}

• err

if err != nil && err != orm.ErrNoRows {
    log.Print("Error:", err)
    return
}

• run

bee run -gendoc=true -downdoc=true