docker安装yapi在线接口文档

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/catoop/article/details/89814072

yapi 可视化在线接口文档

一、安装mongo

自行安装，或者使用你现有的，此处（略）
PS：本人不喜欢把mongo耦合到这个docker中，重装docker什么的还得备份。

二、下载镜像

docker pull xzxiaoshan/yapi

三、创建配置文件

创建配置文件 config.js 内容为：

{
  "port": "3000",
  "adminAccount": "[email protected]",
  "db": {
    "servername": "192.168.x.x",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "yapi",
    "pass": "yapi",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

配置文件中的内容一目了然，请对应修改之。

四、启动docker

初始化DB

docker run -it --rm \
  --entrypoint npm \
  -v /docker/yapi/config.js:/api/config.js
  xzxiaoshan/yapi \
  run install-server

其中 /docker/yapi/config.js 是上一步在本地创建的配置文件。

再运行docker

docker run -d \
  --name xzxiaoshan-yapi \
  -p 3000:3000 \
  xzxioashan/yapi

五、访问yapi

访问 http://192.168.x.x:3000 登录账号 [email protected]，密码 ymfe.org

参考文章：
https://github.com/YMFE/yapi
https://www.jianshu.com/p/a97d2efb23c5