概要说明

1. 接口文档管理：Yapi 提供了一个可视化的接口文档管理界面，用户可以方便地创建、编辑和查看接口文档，以及对接口进行版本控制和历史记录管理。

2. Mock 数据生成：Yapi 具有 Mock 数据生成功能，可以根据接口定义自动生成模拟数据，方便前端开发人员在接口尚未完成时进行开发和测试。

3. 接口测试：Yapi 提供了接口测试功能，用户可以方便地对接口进行测试，并查看测试结果和报告。

4. 权限管理：Yapi 支持多用户协作，可以对用户和团队进行权限管理，确保接口文档的安全和保密性。

5. 团队协作：Yapi 提供了团队协作功能，多人可以同时参与接口文档的编写和管理，提高团队协作效率。

6. 可扩展性：Yapi 提供了丰富的插件和扩展机制，可以根据需要扩展其功能，满足不同的业务需求。

部署

Docker

https://hub.docker.com/r/yapipro/yapi

• YApi Pro 是 YApi 的长期维护分支，我们将长期维护，及时更新、处理问题，欢迎更多社区的小伙伴一起参与。

• 维护团队: yapi-pro

• 开源仓库：yapi-pro/yapi

• 没有使用 docker，本地使用 yapi-cli 部署和维护的小伙伴，可以安装 yapi-pro-cli 直接升级

使用说明

0、Docker 环境准备

1、数据库准备 MongoDB

# 1. 备份 mongoDB 到宿主机，需要使用下面命令创建存储卷
docker volume create mongo-data
# 2.  拉取镜像，国内服务器提供商网络问题，可能会拉取多次才能成功
docker pull mongo:latest
# 3. 启动 MongoDB
# 启动 MongoDB，其中 -e 指定 MONGO_INITDB_ROOT_USERNAME 为 MongoDB 的 ROOT 用户名，MONGO_INITDB_ROOT_PASSWORD 为 MongoDB 的 ROOT 用户密码
docker run -d \
  --name mongodb \
  --restart always \
  --net=yapi \
  -p 27017:27017 \
  -v mongo-data:/data/db \
  -e MONGO_INITDB_DATABASE=yapi \
  -e MONGO_INITDB_ROOT_USERNAME=yapipro \
  -e MONGO_INITDB_ROOT_PASSWORD=yapipro1024 \
  mongo
# 4、查看 MongoDB 容器的启动情况
docker ps -a
# 5、 进入 MongoDB 容器，从第 4 步查看 MongoDB 容器可以获取到容器 id，以下示例使用 2c46d9f59874 代表 MongoDB 的容器 id
 docker exec -it 2c46d9f59874 /bin/sh
# 6、进入 MongoDB 容器后，进入 mongo cli
mongo localhost:27017

use admin;
db.auth("yapipro", "yapipro1024");
# 创建 yapi 数据库
use yapi;
# 创建给 yapi 使用的账号和密码，限制权限
db.createUser({
  user: 'yapi',
  pwd: 'yapi123456',
  roles: [
 { role: "dbAdmin", db: "yapi" },
 { role: "readWrite", db: "yapi" }
  ]
});
# 退出 Mongo Cli
exit
# 退出容器
exit

2、启动 YAPI

 {
   "port": "3000",
   "adminAccount": "hexiaohei1024@gmail.com",
   "timeout":120000,
   "db": {
     "servername": "mongo",
     "DATABASE": "yapi",
     "port": 27017,
     "user": "yapi",
     "pass": "yapi123456",
     "authSource": ""
   },
   "mail": {
     "enable": true,
     "host": "smtp.gmail.com",
     "port": 465,
     "from": "*",
     "auth": {
       "user": "hexiaohei1024@gmail.com",
       "pass": "xxx"
     }
   }
 }

docker pull yapipro/yapi:latest
# 初始化数据库表
docker run -d --rm \
  --name yapi-init \
  --link mongodb:mongo \
  --net=yapi \
  -v /home/docker/Yapi/config.json:/yapi/config.json \
   yapipro/yapi \
  server/install.js
# 初始化管理员账号在上面的 config.json 配置中 hexiaohei1024@gmail.com，初始密码是 yapi.pro，可以登录后进入个人中心修改
docker run -d \
   --name yapi \
   --link mongodb:mongo \
   --restart always \
   --net=yapi \
   -p 3000:3000 \
   -v $PWD/config.json:/yapi/config.json \
   yapipro/yapi \
   server/app.js
# 在服务器上验证 yapi 启动是否成功
curl localhost:3000

1. 访问 Yapi：
在浏览器中访问 http://localhost:3000（如果是在远程服务器上部署，则使用服务器的IP地址和端口号），即可打开 Yapi 的 Web 界面。

2. 初始化 Yapi：
在首次访问时，您将需要进行 Yapi 的初始化设置，包括创建管理员账号、配置数据库连接等。

3. 登录并使用 Yapi：
使用您设置的管理员账号登录 Yapi 后，即可开始在 Yapi 中管理接口文档、Mock 数据等。