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