docker-compose 部署 yapi

摘要

一、为什么选择yapi

1.yapi的功能界面相较于swagger 界面要清晰明了，swagger界面过于粗糙，对于初用swagger的调试小白很不友好。
2.yapi支持分组合作，权限控制做的很好。
3.yapi 支持swagger 接口数据导入。这对已经使用swagger的项目十分友好，能在最短的时间内搭建好完善的接口文档。

yapi部署方案

方法一：官方方案

环境要求

nodejs（7.6+)
mongodb（2.6+）
git

安装

使用我们提供的 yapi-cli 工具，部署 YApi 平台是非常容易的。执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码为 ymfe.org 登录系统（默认密码可在个人中心修改）。

npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server 

方案二：docker-compose 部署

环境要求

docker，docker-compose

安装

1.初始化db, 开启自定义配置

git clone https://github.com/Ryan-Miao/docker-yapi.git
cd docker-yapi
docker-compose up

打开 localhost:9090

默认部署路径为/my-yapi(需要修改docker-compose.yml才可以更改)
修改管理员邮箱 ryan.miao@demo.com (随意, 修改为自己的邮箱)
修改数据库地址为 mongo 或者修改为自己的mongo实例 (docker-compose配置的mongo服务名称叫mongo)
打开数据库认证
输入数据库用户名: yapi(mongo配置的用户名, 见mongo-conf/init-mongo.js)
输入密码: yapi123456(mongo配置的密码, 见mongo-conf/init-mongo.js)
点击开始部署.
部署完毕后, 修改docker-compose.yml 启用

yapi:
    build:
      context: ./
      dockerfile: Dockerfile
    image: yapi
    # 第一次启动使用
    # command: "yapi server"
    # 之后使用下面的命令
    command: "node /my-yapi/vendors/server/app.js"

重启服务:

docker-compose up

访问 localhost:3000

输入用户名ryan.miao@demo.com(自己输入的管理员邮箱)
输入密码ymfe.org(默认的初始化密码, 之后可以修改)
然后可以导入一个swagger的接口数据试试:

后台启动
前台启动确认没问题后, 直接

docker-compose stop或者contrl+C
docker-compose up -d