docker安装yapi

常见的接口文档平台有yapi，rap2等

本文详细介绍yapi的安装部署：

Yapi部署文档

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

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

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

安装mongodb先
跳转：https://www.cnblogs.com/jasonzeng/p/14785388.html
安装yapi：
# 先拉取镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

# 在/data/yapi目录下创建config.json
{
  "port": "3000",
  "adminAccount": "xxxx@qq.com",
  "closeRegister":true,
  "db": {
    "servername": "mongo",
    "DATABASE": "yapi",
    "port": 27017,
    "user":"dev",
    "pass":"xxxxx",
    "authSource":"admin"
  },
  "mail": {
    "enable": true,
    "host": "smtp.qq.com",
    "port": 465,
    "from": "xxxxx@qq.com",
    "auth": {
      "user": "xxxx@qq.com",
      "pass": "xxxxx"
    }
  }
}

初始化 Yapi 数据库索引及管理员账号
docker run -it --rm \
  -v /data/yapi/config.json:/api/config.json \
  --link mongodb:mongo \
  --entrypoint npm \
  --workdir /api/vendors \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  run install-server
启动Yapi服务
docker run -d \
  -v /data/yapi/config.json:/api/config.json \
  --name yapi \
  --link mongodb:mongo \
  --workdir /api/vendors \
  -p 3000:3000 \
  registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
  server/app.js
访问 http://localhost:3000 登录账号xxxx@qq.com，密码 ymfe.org

禁用注册

docker exec  -it yapi /bin/sh

vi ../config.json 

#修改内容如下
{
  "port": "3000",
  "adminAccount": "xxxx@qq.com",
  "closeRegister":true, #主要是添加这句配置
  
}#保存后退出exit #退出容器docker restart yapi #重启服务

禁用注册后怎么添加用户呢，登录yapi，然后添加一个项目，增加一个注册用户接口

地址为：http://yapi:端口/api/user/reg

POST json

{
  "email": "xx@xxx.com",
  "password": "xxx@xxx.com",
  "username": "xxxx"
}
每次注册完成后，需求退出重新进入，不然有垮session问题

 

官方文档：

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

转自：

juejin.cn/post/6844904015679979527

blog.csdn.net/zgq916464/article/details/106145832/

www.cnblogs.com/binz/p/12684610.html

 

 

rap2安装直通车：

https://www.jianshu.com/p/84df2ced8e76

https://www.cnblogs.com/operationhome/p/10038469.html