beego生成api工程

生成beego工程之前需要先配置好beego與bee環(huán)境

生成beego工程

本工程采用api的形式盗棵,不需要界面冰更,所以使用bee api的方式生成工程贰健,bee工具非常好用北滥,可以用以下方式根據(jù)數(shù)據(jù)庫(kù)的結(jié)構(gòu)自動(dòng)生成工程
bee api appName -driver=mysql -conn="root:password@tcp(localhost:3306)/test" 勺美,其中appName是工程名稱,-driver=mysql是指生成工程的數(shù)據(jù)庫(kù)是mysql碑韵,-conn="root:password@tcp(localhost:3306)/test"mysql連接信息赡茸。

postgres數(shù)據(jù)庫(kù)生成:
bee api data_sync -driver=postgres -conn="postgres://postgres:postgres@127.0.0.1:5432/postgres?sslmode=disable"

根據(jù)特定數(shù)據(jù)表快速生成代碼

bee generate appcode -tables="tablename1,tablename2" -driver=mysql -conn="root:password@tcp(127.0.0.1:3306)/test" -level=3,其中level為生成代碼的級(jí)別
可通過(guò)help命令查看具體用法:

bee help generate
USAGE
  bee generate [command]
OPTIONS
  -conn  Connection string used by the SQLDriver to connect to a database instance.
  -ddl  Generate DDL Migration
  -driver  Database SQLDriver. Either mysql, postgres or sqlite.
  -fields  List of table Fields.
  -level  Either 1, 2 or 3. i.e. 1=models; 2=models and controllers; 3=models, controllers and routers.
  -tables  List of table names separated by a comma.
DESCRIPTION
  ? To scaffold out your entire application:
     $ bee generate scaffold [scaffoldname] [-fields="title:string,body:text"] [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"]
  ? To generate a Model based on fields:
     $ bee generate model [modelname] [-fields="name:type"]
  ? To generate a controller:
     $ bee generate controller [controllerfile]
  ? To generate a CRUD view:
     $ bee generate view [viewpath]
  ? To generate a migration file for making database schema updates:
     $ bee generate migration [migrationfile] [-fields="name:type"]
  ? To generate swagger doc file:
     $ bee generate docs
  ? To generate a test case:
     $ bee generate test [routerfile]
  ? To generate appcode based on an existing database:
     $ bee generate appcode [-tables=""] [-driver=mysql] [-conn="root:@tcp(127.0.0.1:3306)/test"] [-level=3]

進(jìn)程內(nèi)監(jiān)控

beego提供了應(yīng)用信息的監(jiān)控和展示祝闻,可以查看實(shí)時(shí)信息比如qps占卧,健康狀況,程序性能相關(guān)(goroutine联喘,gc华蜒,cpu等),可以查看靜態(tài)信息比如路由配置豁遭,conf配置信息叭喜,過(guò)濾器信息,還可以查看和觸發(fā)任務(wù)蓖谢。
進(jìn)程監(jiān)控默認(rèn)是關(guān)閉的捂蕴,可以通過(guò)簡(jiǎn)單的配置中打開(kāi)譬涡,很方便:

EnableAdmin = true
AdminHttpAddr = 0.0.0.0 #默認(rèn)監(jiān)聽(tīng)地址是localhost
AdminHttpPort = 8088

自動(dòng)化文檔

beego通過(guò)swagger和內(nèi)部的注釋解析能夠?qū)崿F(xiàn)自動(dòng)文檔的效果,使用方法:

  1. routers/router.go中路由只能使用namespace+Include的寫(xiě)法啥辨,而且只支持二級(jí)解析涡匀,一級(jí)版本號(hào),二級(jí)分別表示應(yīng)用模塊溉知。
  2. routers/router.go文件中設(shè)置全局的應(yīng)用信息陨瘩。注意,必須寫(xiě)在文件頂部级乍。
  3. 注釋的格式(每個(gè)字段的含義可以參照Auto Docs):
 // @Title login
 // @Description Logs user into the system
 // @Param   username        query   string  true        "The username for login"
 // @Param   password        query   string  true        "The password for login"
 // @Success 200 {string} login success
 // @Failure 403 user not exist
 // @router /login [get]
 func (u *UserController) Login() {
     username := u.GetString("username")
     password := u.GetString("password")
     if models.Login(username, password) {
         u.Data["json"] = "login success"
     } else {
         u.Data["json"] = "user not exist"
     }
     u.ServeJSON()
 }

4.在配置文件中打開(kāi)自動(dòng)文檔配置:
EnableDocs = true
5.啟動(dòng)時(shí)添加自動(dòng)文檔參數(shù):
bee run -gendoc=true -downdoc=true
滿足以上配置舌劳,beego會(huì)自動(dòng)解析控制器中的注釋,啟動(dòng)swagger服務(wù)玫荣,并在/docs接口上提供已生成好的json字串蒿囤。
訪問(wèn)swagger服務(wù)并在swagger中訪問(wèn)/docs接口,即可看到接口的文檔崇决,同時(shí)也可以對(duì)接口進(jìn)行測(cè)試材诽。

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市恒傻,隨后出現(xiàn)的幾起案子脸侥,更是在濱河造成了極大的恐慌,老刑警劉巖盈厘,帶你破解...
    沈念sama閱讀 222,627評(píng)論 6 517
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件睁枕,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡沸手,警方通過(guò)查閱死者的電腦和手機(jī)外遇,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 95,180評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)契吉,“玉大人跳仿,你說(shuō)我怎么就攤上這事【杈В” “怎么了菲语?”我有些...
    開(kāi)封第一講書(shū)人閱讀 169,346評(píng)論 0 362
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)惑灵。 經(jīng)常有香客問(wèn)我山上,道長(zhǎng),這世上最難降的妖魔是什么英支? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 60,097評(píng)論 1 300
  • 正文 為了忘掉前任佩憾,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘妄帘。我一直安慰自己楞黄,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 69,100評(píng)論 6 398
  • 文/花漫 我一把揭開(kāi)白布寄摆。 她就那樣靜靜地躺著谅辣,像睡著了一般修赞。 火紅的嫁衣襯著肌膚如雪婶恼。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,696評(píng)論 1 312
  • 那天柏副,我揣著相機(jī)與錄音勾邦,去河邊找鬼。 笑死割择,一個(gè)胖子當(dāng)著我的面吹牛眷篇,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播荔泳,決...
    沈念sama閱讀 41,165評(píng)論 3 422
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼蕉饼,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了玛歌?” 一聲冷哼從身側(cè)響起昧港,我...
    開(kāi)封第一講書(shū)人閱讀 40,108評(píng)論 0 277
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎支子,沒(méi)想到半個(gè)月后创肥,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,646評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡值朋,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,709評(píng)論 3 342
  • 正文 我和宋清朗相戀三年叹侄,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片昨登。...
    茶點(diǎn)故事閱讀 40,861評(píng)論 1 353
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡趾代,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出丰辣,到底是詐尸還是另有隱情稽坤,我是刑警寧澤,帶...
    沈念sama閱讀 36,527評(píng)論 5 351
  • 正文 年R本政府宣布糯俗,位于F島的核電站尿褪,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏得湘。R本人自食惡果不足惜杖玲,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 42,196評(píng)論 3 336
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望淘正。 院中可真熱鬧摆马,春花似錦臼闻、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,698評(píng)論 0 25
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至蕉毯,卻和暖如春乓搬,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背代虾。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,804評(píng)論 1 274
  • 我被黑心中介騙來(lái)泰國(guó)打工进肯, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人棉磨。 一個(gè)月前我還...
    沈念sama閱讀 49,287評(píng)論 3 379
  • 正文 我出身青樓江掩,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親乘瓤。 傳聞我的和親對(duì)象是個(gè)殘疾皇子环形,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,860評(píng)論 2 361

推薦閱讀更多精彩內(nèi)容