beego自動化文檔

因為beego的更新,一些使用自動化文檔的方法也有了更新,請參考:http://www.lxweimin.com/p/0dc261bc5cea

beego是什么?

beego是一個快速開發go應用http框架go 語言技術大牛ASTA謝的開源項目。
beego可以用來快速開發APIWeb以及后端服務等各種應用,是一個RESTFul的框架,主要設計靈感來源于tornadosinatraflask這三個框架,結合了Go本身的一些特性(interfacestruct繼承等)而設計的。
beego結合swagger就能實現自動化的文檔。

Swagger是什么?

Swagger 是一個規范和一套完整的框架,用于生成描述調用以及可視化 RESTful 風格Web 服務
Swagger的總體目標是使客戶端和文件系統服務器以同樣的速度來更新,方法,參數和模型緊密集成到服務器端的代碼中,允許API始終保持同步。
Swagger 讓部署管理和使用API從未如此簡單。

自動文檔的好處?

1. 不用手動寫文檔了,通過注解就可以自動化文檔
2. 文檔和代碼同步更新,代碼更新之后不需要再更新文檔
3. 瀏覽器友好
4. 使用Swagger框架可以調試API,在瀏覽器端可以看到更多的`request`和`response`信息

使用指南

首先安裝go:http://www.lxweimin.com/p/943870134593
可以使用intelliJ作為go的IDE:http://www.lxweimin.com/p/943870134593
也可以使用Atom作用go的IDE:http://www.lxweimin.com/p/c1d8cf274ec7

安裝beego:http://beego.me/quickstart
使用go get安裝beego:

go get github.com/astaxie/beego

安裝bee工具:

go get github.com/beego/bee

未了方面可以把$GOPATH/bin加入到你的$PATH變量中:

export PATH=$PATH:$GOPATH/bin

創建一個beego項目

使用bee工具可以方便的創建,管理,運行,打包beego項目:

bee api beeapi

必須在$GOPATH/src的目錄下創建項目。
為該項目指定Swagger目錄:

beego.StaticDir["/swagger"] = "swagger"

下載Swagger:https://github.com/beego/swagger
也可以下載最新的Swagger:http://swagger.io/

放到項目的根目錄下面,目錄名稱為swagger,和上面的配置一致。

路由解析

目前自動化文檔的路由規則只支持NewNamespace寫法的解析,其他寫法函數不會自動解析為文章,就是namespace+Include的寫法。而且只支持二級解析,其中一級表示版本號,二級表示應用模塊。
如:

    ns := beego.NewNamespace("/v1",
        beego.NSNamespace("/object",
            beego.NSInclude(
                &controllers.ObjectController{},
            ),
        ),
        beego.NSNamespace("/user",
            beego.NSInclude(
                &controllers.UserController{},
            ),
        ),
    )
    beego.AddNamespace(ns)

生成文檔

在配置文件conf/app.conf中設置

EnableDocs = true

生成docs文件:

bee generate docs

文檔的生成在 docs文件的init函數中調用的,因此必須在main中導入docs文件,這樣就會調用docs的init函數

  _ "beeapi/docs"

運行程序:

bee run watchall true

bee run命令是監控beego的項目文件,通過fsnotify監控文件系統,這樣在開發的過程中可以實時的看到項目修改之后的效果。

打開http://127.0.0.1:8080/swagger/就可以看到自動化文檔的界面

swagger

也可以運行下面命令改變docs的端口號:

bee run docs -docport=8888

注解

beego的文檔注解包括兩種:全局注解和應用注解.
全局注釋,必須放在router.go的最頂部,包括:

    @APIVersion
    @Title
    @Description
    @Contact
    @TermsOfServiceUrl
    @License
    @LicenseUrl

應用注釋,需要放在對應方法的上面,包括:

    @title
    @Description
    @Param
    @Success
    @Failure
    @router 

測試項目地址:https://github.com/jjz/go/tree/master/autodoc

參考文檔:http://beego.me/docs/advantage/docs.md

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 228,119評論 6 531
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 98,382評論 3 415
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 176,038評論 0 373
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 62,853評論 1 309
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 71,616評論 6 408
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,112評論 1 323
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,192評論 3 441
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 42,355評論 0 288
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 48,869評論 1 334
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 40,727評論 3 354
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 42,928評論 1 369
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 38,467評論 5 358
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,165評論 3 347
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 34,570評論 0 26
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 35,813評論 1 282
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 51,585評論 3 390
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 47,892評論 2 372

推薦閱讀更多精彩內容