beego註解路由中各個引數解釋

hantmac發表於2019-01-03
Go路由

beego註解路由的註釋，我們可以把我們的註釋分為以下類別：

  • @Title

    介面的標題，用來標示唯一性，唯一，可選

    格式：之後跟一個描述字串

  • @Description

    介面的作用，用來描述介面的用途，唯一，可選

    格式：之後跟一個描述字串

  • @Param

    請求的引數，用來描述接受的引數，多個，可選

    格式：變數名 傳輸型別 型別 是否必須 描述

    傳輸型別：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進行資料的傳輸
    • header 表示通過header進行資料的傳輸

  • @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]
複製程式碼

相關文章