YApi 运维 | LINUX-TUTORIAL

YApi (opens new window) 是一个可本地部署的、打通前后端及 QA 的、可视化的接口管理平台。

本文目的在于记录 svn 的安装、配置、使用。

img

# 1. 普通部署

# 1.1. 环境要求

  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

# 1.2. 部署

# 方式一. 可视化部署[推荐]

执行 yapi server 启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定 url, 点击登录输入您刚才设置的管理员邮箱,默认密码(ymfe.org) 登录系统(默认密码可在个人中心修改)。

# 方式二. 命令行部署

如果 github 压缩文件无法下载,或需要部署到一些特殊的服务器,可尝试此方法

安装后的目录结构如下:

# 1.3. 升级

升级项目版本是非常容易的,并且不会影响已有的项目数据,只会同步 vendors 目录下的源码文件。

# 2. Docker 部署

# 2.1. 环境要求

  • 系统:CentOS 7.4
  • 硬件要求:1 GB RAM minimum
  • ip:http://192.168.1.121
  • docker version:17.12.1-ce, build 7390fc6
  • docker-compose version:1.18.0, build 8dd22a9

建议部署成 http 站点,因 chrome 浏览器安全限制,部署成 https 会导致测试功能在请求 http 站点时文件上传功能异常。--来源 (opens new window)

# 2.2. 部署

  • 一个好心人的维护:https://github.com/branchzero/yapi-docker (opens new window)
  • 使用方法: - work path:mkdir -p /opt/git-data - clone:cd /opt/git-data && git clone https://github.com/branchzero/yapi-docker.git - permission:chmod -R 777 /opt/git-data - run command:cd /opt/git-data/yapi-docker && docker-compose up -d - open chrome:http://192.168.1.121:3000
  • 初始化管理员账号名:admin@admin.com,密码:ymfe.org

# 3. 参考资料