Yapi部署文档

Yapi 由 YMFE开源，旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护API。

权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
可视化接口管理 基于 websocket的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率
Mock Server 易用的 Mock Server，再也不用担心 mock 数据的生成了
自动化测试 完善的接口自动化测试,保证数据的正确性
数据导入 支持导入swagger, postman, har数据格式，方便迁移旧项目
插件机制 强大的插件机制，满足各类业务需求

Yapi支持内网部署，只需在管理员或内网某台机器上安装部署一次，团队其他成员不需要部署，访问相应的地址即可使用。本部分内容只需负责配置环境人员阅读，需要相关人员具有基本的node与mongodb知识。

环境要求

nodejs(7.6+)•
nodejs、npm 环境配置步骤(windows版本)
mongodb(2.6+)•
Windows下安装MongoDB
git•
Git安装教程（Windows安装超详细教程)

使用Docker构建Yapi(Ubuntu环境)

启动mongodb

docker run -d --name mongo-yapi -p 27017:27017 mongo

获取 Yapi 镜像，版本信息可在阿里云镜像仓库查看

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

自定义配置文件挂载到目录/api/config.json,官方自定义配置文件 -> 传送门，宿主机/config/config.json内容为

{
  "port": "3000",
  "adminAccount": "1159011520@qq.com",
  "db": {
    "servername": "mongo-yapi",
    "DATABASE": "yapi",
    "port": 27017
  },
  "mail": {
    "enable": true,//邮件通知
    "host": "smtp.qq.com",//邮箱服务器
    "port": 465,
    "from": "1159011520@qq.com",//发件人邮箱
    "auth": {
      "user": "1159011520@qq.com",//邮箱服务器账号
      "pass": "bvbmeiieuuczjdaj"//邮箱服务器密码
    }
  }
}

初始化 Yapi 数据库索引及管理员账号

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

启动Yapi服务

docker run -d \
  -v /config/config.json:/api/config.json \
  --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 登录账号 1159011520@glodon.com，密码 ymfe.org

不更改配置文件的话，默认配置文件为

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

默认为登录账号 admin@admin.com，密码 ymfe.org

请参考：

https://www.jianshu.com/p/a97d2efb23c5
https://www.cnblogs.com/Don/p/10523617.html
https://github.com/YMFE/yapi
https://www.cnblogs.com/qgc1995/p/9549896.html

文档地址

https://hellosean1025.github.io/yapi/documents/