一、什麼是Yapi
Yapi 由 YMFE 開源,旨在為開發、産品、測試人員提供更優雅的接口管理服務,可以幫助開發者輕松建立、釋出、維護 API。
1.權限管理
YApi 成熟的團隊管理扁平化項目權限配置滿足各類企業的需求
2.可視化接口管理
基于 websocket 的多人協作接口編輯功能和類 postman 測試工具,讓多人協作成倍提升開發效率
3.Mock Server
易用的 Mock Server,再也不用擔心 mock 資料的生成了
4.自動化測試
完善的接口自動化測試,保證資料的正确性
5.資料導入
支援導入 swagger, postman, har 資料格式,友善遷移舊項目
6.插件機制
強大的插件機制,滿足各類業務需求
二、安裝docker部署
1.yapi的源碼在:https://github.com/YMFE/yapi/blob/master/config_example.json
2.安裝docker
前提條件:
目前,CentOS 僅發行版本中的核心支援 Docker。Docker 運作在 CentOS 7 上,要求系統為64位、系統核心版本為 3.10 以上。Docker 運作在 CentOS-6.5 或更高的版本的 CentOS 上,要求系統為64位、系統核心版本為 2.6.32-431 或者更高版本。使用 yum 安裝(CentOS 7下)Docker 要求 CentOS 系統的核心版本高于 3.10 ,檢視本頁面的前提條件來驗證你的CentOS 版本是否支援 Docker 。
通過 uname -r 指令檢視你目前的核心版本
[root@runoob ~]# uname -r
.-.el7.x86_64
3.安裝 Docker
Docker 軟體包和依賴包已經包含在預設的 CentOS-Extras 軟體源裡,安裝指令如下:
Installed:
docker.x86_64 :-git1398f24.el7.centos
Dependency Installed:
container-selinux.noarch :-gite7096ce.el7 docker-client.x86_64 :-git1398f24.el7.centos docker-common.x86_64 :-git1398f24.el7.centos oci-register-machine.x86_64 :-.gitdd0daef.el7
oci-systemd-hook.x86_64 :-git2788078.el7 skopeo-containers.x86_64 :-el7
Updated:
selinux-policy-targeted.noarch :-el7_3 systemd.x86_64 :-el7_3
Dependency Updated:
libgudev1.x86_64 :-el7_3 libselinux.x86_64 :-el7 libselinux-python.x86_64 :-el7 libselinux-utils.x86_64 :-el7 libsemanage.x86_64 :-.el7_3
libsemanage-python.x86_64 :-.el7_3 libsepol.x86_64 :-el7 policycoreutils.x86_64 :-el7_3 policycoreutils-python.x86_64 :-el7_3 selinux-policy.noarch :-el7_3
setools-libs.x86_64 :-.el7 systemd-libs.x86_64 :-el7_3 systemd-python.x86_64 :-el7_3 systemd-sysv.x86_64 :-el7_3
Complete!
出現這樣的說明安裝成功。
4.啟動 Docker 背景服務
5.驗證Docker安裝是否成功
三、使用 Docker 建構 Yapi
1.建立 MongoDB 資料卷
2.啟動 MongoDB
docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo
3.擷取 Yapi 鏡像,版本資訊可在 阿裡雲鏡像倉庫 檢視 :
位址: https://dev.aliyun.com/detail.html?spm=5176.1972343.2.26.I97LV8&repoId=139034
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
4.初始化 Yapi 資料庫索引及管理者賬号
5.啟動 Yapi 服務
docker run -d --name yapi --link mongo-yapi:mongo --workdir /api/vendors -p : registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js
6.使用 Yapi
通路
http://localhost:3000
登入賬号
[email protected]
,密碼
ymfe.org
7.其他相關操作
7.1關閉 Yapi
docker stop yapi
7.2啟動 Yapi
7.3停止并删除舊版容器
docker rm -f yapi
7.4擷取最新鏡像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
7.5啟動新容器
docker run -d --name yapi --link mongo-yapi:mongo --workdir /api/vendors -p : registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js
參看:《https://yapi.ymfe.org/documents/index.html》