API 文檔管理工具 (Yapi) Docker Compose部署指南

前言介紹

Yapi 由 YMFE 開源，旨在爲開發、產品、測試人員提供更優雅的接口管理服務，能夠幫助開發者輕鬆建立、發佈、維護 API。

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

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

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

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

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

• 插件機制
  強大的插件機制，知足各種業務需求

獲取 Yapi 鏡像，版本信息可在 阿里雲鏡像倉庫 查看

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

建立配置文件config.json, 並掛載到Docker容器中的目錄 /api/config.json，官方自定義配置文件 -> 傳送門

{
  "port": "3000",
  "adminAccount": "***",
  "db": {
    "servername": "***",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "yapi",
    "pass": "***",
    "authSource": "yapi"
  },
  "mail": {
    "enable": false,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

　　初始化 Yapi 數據庫索引及管理員帳號

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

　　

　　建立docker-compose.yml文件，並啓動 Yapi 服務

Yapi:
  image: registry.cn-hangzhou.aliyuncs.com/anoy/yapi
  container_name: "yapi"
  volumes:
    - /config/config.json:/api/config.json
  restart: always
  ports:
    - "3000:3000"
  working_dir: /api/vendors
  command: server/app.js

　　

　　啓動Yapi服務

docker-compose up -d