頂尖 API 文檔管理工具 (Yapi)

前言介紹

Yapi 由 YMFE 開源缨称,旨在為開發(fā)宴树、產(chǎn)品于置、測試人員提供更優(yōu)雅的接口管理服務野崇,可以幫助開發(fā)者輕松創(chuàng)建袜蚕、發(fā)布糟把、維護 API。

  • 權限管理
    YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業(yè)的需求

  • 可視化接口管理
    基于 websocket 的多人協(xié)作接口編輯功能和類 postman 測試工具牲剃,讓多人協(xié)作成倍提升開發(fā)效率

  • Mock Server
    易用的 Mock Server遣疯,再也不用擔心 mock 數(shù)據(jù)的生成了

  • 自動化測試
    完善的接口自動化測試,保證數(shù)據(jù)的正確性

  • 數(shù)據(jù)導入
    支持導入 swagger, postman, har 數(shù)據(jù)格式,方便遷移舊項目

  • 插件機制
    強大的插件機制凿傅,滿足各類業(yè)務需求

去哪兒網(wǎng)移動架構(gòu)組(YMFE)是由FE缠犀,iOS和Android工程師共同組成的,去哪兒最具想象力聪舒、創(chuàng)造力和影響力的大前端團隊辨液。

使用 Docker 構(gòu)建 Yapi

1、創(chuàng)建 MongoDB 數(shù)據(jù)卷

docker volume create mongo_data_yapi

2箱残、啟動 MongoDB

docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo

3滔迈、獲取 Yapi 鏡像,版本信息可在 阿里云鏡像倉庫 查看

docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

4被辑、初始化 Yapi 數(shù)據(jù)庫索引及管理員賬號

docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server

自定義配置文件掛載到目錄 /api/config.json燎悍,官方自定義配置文件 -> 傳送門

5、啟動 Yapi 服務

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js

使用 Yapi

訪問地址 http://localhost:3000

登錄盼理,賬號 admin@anoyi.com谈山,密碼 anoyi.com

至此,帥氣的 Yapi 就可以輕松使用啦榜揖!更多文檔信息勾哩,請參考

其他相關操作

關閉 mongo-yapi

docker stop mongo-yapi

啟動 mongo-yapi

docker start mongo-yapi

關閉 Yapi

docker stop yapi

啟動 Yapi

docker start yapi

升級 Yapi

# 1、停止并刪除舊版容器
docker rm -f yapi

# 2举哟、獲取最新鏡像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

下載指定版本
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi:v1.3.16

重命名鏡像tag
docker tag 1af2bc1b190b registry.cn-hangzhou.aliyuncs.com/anoy/yapi:latest

# 3思劳、啟動新容器
docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js
  • docker鏡像重命名和tag

docker鏡像重命名和tag
docker tag IMAGEID(鏡像id) REPOSITORY:TAG(倉庫:標簽)
#例子
docker tag ca1b6b825289 registry.cn-hangzhou.aliyuncs.com/xxxxxxx:v1.0

刪除相同名稱 和images id的鏡像
repository:tag的組合來刪除特殊的鏡像
docker rmi registry.cn-hangzhou.aliyuncs.com/anoy/yapi:v1.3.16
刪除相同images id,不同名稱的鏡像
docker rmi registry.cn-hangzhou.aliyuncs.com/anoy/yapi/latest
刪除容器
docker rm 容器名稱
最后編輯于
?著作權歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末妨猩,一起剝皮案震驚了整個濱河市潜叛,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌壶硅,老刑警劉巖威兜,帶你破解...
    沈念sama閱讀 219,490評論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場離奇詭異庐椒,居然都是意外死亡椒舵,警方通過查閱死者的電腦和手機,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,581評論 3 395
  • 文/潘曉璐 我一進店門约谈,熙熙樓的掌柜王于貴愁眉苦臉地迎上來笔宿,“玉大人犁钟,你說我怎么就攤上這事∑瞄伲” “怎么了涝动?”我有些...
    開封第一講書人閱讀 165,830評論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長炬灭。 經(jīng)常有香客問我醋粟,道長,這世上最難降的妖魔是什么重归? 我笑而不...
    開封第一講書人閱讀 58,957評論 1 295
  • 正文 為了忘掉前任米愿,我火速辦了婚禮,結(jié)果婚禮上提前,老公的妹妹穿的比我還像新娘吗货。我一直安慰自己,他們只是感情好狈网,可當我...
    茶點故事閱讀 67,974評論 6 393
  • 文/花漫 我一把揭開白布宙搬。 她就那樣靜靜地躺著,像睡著了一般拓哺。 火紅的嫁衣襯著肌膚如雪勇垛。 梳的紋絲不亂的頭發(fā)上,一...
    開封第一講書人閱讀 51,754評論 1 307
  • 那天士鸥,我揣著相機與錄音闲孤,去河邊找鬼。 笑死烤礁,一個胖子當著我的面吹牛讼积,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播脚仔,決...
    沈念sama閱讀 40,464評論 3 420
  • 文/蒼蘭香墨 我猛地睜開眼勤众,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了鲤脏?” 一聲冷哼從身側(cè)響起们颜,我...
    開封第一講書人閱讀 39,357評論 0 276
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎猎醇,沒想到半個月后窥突,有當?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,847評論 1 317
  • 正文 獨居荒郊野嶺守林人離奇死亡硫嘶,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點故事閱讀 37,995評論 3 338
  • 正文 我和宋清朗相戀三年阻问,在試婚紗的時候發(fā)現(xiàn)自己被綠了。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片沦疾。...
    茶點故事閱讀 40,137評論 1 351
  • 序言:一個原本活蹦亂跳的男人離奇死亡称近,死狀恐怖贡蓖,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情煌茬,我是刑警寧澤,帶...
    沈念sama閱讀 35,819評論 5 346
  • 正文 年R本政府宣布彻桃,位于F島的核電站坛善,受9級特大地震影響,放射性物質(zhì)發(fā)生泄漏邻眷。R本人自食惡果不足惜眠屎,卻給世界環(huán)境...
    茶點故事閱讀 41,482評論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望肆饶。 院中可真熱鬧改衩,春花似錦、人聲如沸驯镊。這莊子的主人今日做“春日...
    開封第一講書人閱讀 32,023評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽板惑。三九已至橄镜,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間冯乘,已是汗流浹背洽胶。 一陣腳步聲響...
    開封第一講書人閱讀 33,149評論 1 272
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留裆馒,地道東北人姊氓。 一個月前我還...
    沈念sama閱讀 48,409評論 3 373
  • 正文 我出身青樓,卻偏偏與公主長得像喷好,于是被迫代替她去往敵國和親翔横。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 45,086評論 2 355