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

前言介紹

Yapi 由 YMFE 開源，旨在為開發、產品、測試人員提供更優雅的接口管理服務，可以幫助開發者輕松創建、發布、維護 API。

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

• 可視化接口管理
  基於 websocket 的多人協作接口編輯功能和類 postman 測試工具，讓多人協作成倍提升開發效率

• Mock Server
  易用的 Mock Server，再也不用擔心 mock 數據的生成了

• 自動化測試
  完善的接口自動化測試,保證數據的正確性

• 數據導入
  支持導入 swagger, postman, har 數據格式，方便遷移舊項目

• 插件機制
  強大的插件機制，滿足各類業務需求

使用 Docker 構建 Yapi

1、創建 MongoDB 數據卷

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 數據庫索引及管理員賬號

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 登錄賬號 [e-mail]，密碼 ymfe.org

 

 

 

 

至此，帥氣的 Yapi 就可以輕松使用啦！更多文檔信息，請參考

• Yapi 官方文檔
• 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 # 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 

構建任意版本 yapi 鏡像

提示：以下所有文件均放在同一目錄下

1、編寫 Dockerfile

FROM node:9.2-alpine as builder RUN apk add --no-cache git python make openssl ADD yapi.zip /yapi.zip RUN mkdir /api && \ unzip yapi.zip && \ rm -f yapi.zip && \ mv yapi* /api/vendors RUN cd /api/vendors && \ npm install --production --registry https://registry.npm.taobao.org FROM node:9.2-alpine MAINTAINER [e-mail] ENV TZ="Asia/Shanghai" HOME="/" WORKDIR ${HOME} COPY --from=builder /api/vendors /api/vendors COPY config.json /api/ EXPOSE 3000 ENTRYPOINT ["node"] 

2、自定義配置文件 config.json

{
  "port": "3000", "adminAccount": "[e-mail]", "db": { "servername": "mongo", "DATABASE": "yapi", "port": 27017 } } 

3、鏡像構建腳本 build

echo -e "\033[32m download new package (version $1) \033[0m" wget -O yapi.zip http://yapi.demo.qunar.com/publicapi/archive/$1 echo -e "\033[32m build new image \033[0m" docker build -t registry.cn-hangzhou.aliyuncs.com/anoy/yapi . 

使腳本可執行： chmod a+x build

4、本地構建鏡像，版本列表 -> 傳送門

./build <Version> 

示例： ./build v1.3.22

作者：Anoyi
鏈接：https://www.jianshu.com/p/a97d2efb23c5
來源：簡書