介紹
給大家推薦一個開源接口管理平臺YApi,眾多互聯(lián)網(wǎng)大廠都在使用
YApi 的一些客戶:百度,阿里巴巴,騰訊,今日頭條等
GitHub地址:https://github.com/YMFE/yapi
github上有本地安裝的教程,因為Docker安裝比較方便,因此官方推薦了如下docker安裝教程,當然docker鏡像不是官方做的。建議配置阿里云Docker鏡像倉庫,下載起來比較快
使用 Docker 構(gòu)建 YApi
1.啟動 MongoDB
docker run -d --name mongo-yapi mongo
1
2.獲取 Yapi 鏡像,版本信息可在 阿里云鏡像倉庫 查看
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
1
3.初始化 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
123456
自定義配置文件掛載到目錄 /api/config.json,官方自定義配置文件https://github.com/YMFE/yapi/blob/master/config_example.json
4.啟動 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
1234567
使用 Yapi
訪問 http://localhost:3000 登錄賬號 [email protected],密碼 ymfe.org


至此,帥氣的 YApi 就可以輕松使用啦!更多文檔信息,請參考
YApi 官方教程https://hellosean1025.github.io/yapi/documents/index.html
YApi 版本更新記錄https://github.com/YMFE/yapi/blob/master/CHANGELOG.md
其他相關(guān)操作
1.關(guān)閉 YApi
docker stop yapi
1
2.啟動YApi
docker start yapi
1
3.升級 YApi
# 1、停止并刪除舊版容器
docker rm -f yapi
# 2、獲取最新鏡像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
# 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
1234567891011121314
手動構(gòu)建 YApi 鏡像
1.下載 YApi 到本地
wget -o yapi.tar.gz https://github.com/YMFE/yapi/archive/v1.8.0.tar.gz
1
下載地址:https://github.com/YMFE/yapi/releases
2.編輯 Dockerfile
FROM node:12-alpine as builder
RUN apk add --no-cache git Python make openssl tar gcc
COPY yapi.tar.gz /home
RUN cd /home && tar zxvf yapi.tar.gz && mkdir /api && mv /home/yapi-1.8.0 /api/vendors
RUN cd /api/vendors &&
npm install --production --registry https://registry.npm.taobao.org
FROM node:12-alpine
MAINTAINER [email protected]
ENV TZ="Asia/Shanghai" HOME="/"
WORKDIR ${HOME}
COPY --from=builder /api/vendors /api/vendors
COPY config.json /api/
EXPOSE 3000
ENTRYPOINT ["node"]
1234567891011121314151617181920212223242526
3.構(gòu)建鏡像
docker build -t yapi .