Yapi 使用docker在cenos7上部署教程与基本使用

✅ 前提条件

确保你已经完成以下准备：

• CentOS 7 系统已安装 Docker（未安装请先安装）
• 拥有管理员权限（root 或 sudo）

1、安装mongo数据库

# 拉取mongo镜像，有本地镜像包可以直接导入
docker pull mongo
# 安装mongo数据库服务
# 创建存储卷
docker volume create mongo-data
# 启动 MongoDB
docker run -d \
  --name mongo-yapi \
  -v mongo-data:/data/db \
  -p 27017:27017 \
  -e MONGO_INITDB_ROOT_USERNAME=admin \
  -e MONGO_INITDB_ROOT_PASSWORD=123456 \
  mongo

2、初始化yapi的管理员账号和密码：

# 拉取yapi镜像包
docker pull registry.cn-hangzhou.aliyuncs.com/anoyi/yapi

#自定义名称为config.json的配置文件 创建目录（路径随意）

mkdir -p /data/yapi-config

# 一次性写入 config.json
cat > /data/yapi-config/config.json <<'EOF'
{
　　"port": "3000",
　　"adminAccount": "admin@anoyi.com",
　　"timeout": 120000,
　　"db": {
　　　　"servername": "mongo",
　　　　"DATABASE": "yapi",
　　　　"port": 27017,
　　　　"user": "admin",
　　　　"pass": "123456",
　　　　"authSource": "admin"
　　}
}
EOF

# 初始化管理员账户和密码
docker run -it --rm \
  --link mongo-yapi:mongo \
  --entrypoint npm \
  --workdir /yapi/vendors \
  -v /data/yapi-config/config.json:/yapi/config.json \
  registry.cn-hangzhou.aliyuncs.com/anoyi/yapi \
  run install-server

效果如下：

 最后初始化yapi容器：

docker run -d \
  --name yapi \
  --link mongo-yapi:mongo \
  --workdir /yapi/vendors \
  -p 3000:3000 \
  -v /data/yapi-conifg/config.json:/yapi/config.json \
  registry.cn-hangzhou.aliyuncs.com/anoyi/yapi \
  server/app.js

访问路径：

访问： http://192.168.200.130:3000
登录账号：admin@anoyi.com
密码：ymfe.org

登录后效果：

 

注意：

重启yapi服务时，需要同时启动mongo服务，可通过 docker start mongo-yapi yapi 启动

 如果需要设置开机启动：

1、容器已运行

docker update --restart=always mongo-yapi

docker update --restart=always yapi

2、在创建的时候命令中加入restart=always

docker run -d \
  --name mongo-yapi \
  --restart=always \  
  ...

docker run -d \
  --name yapi \
  --restart=always \
  ...

两者取一即可

3、Yapi基本使用

登录到Yapi平台之后，我们可以创建项目，在项目下创建接口分类，在对应的分类中添加接口。

1). 创建项目

 

 

 

2). 添加分类

在当前项目中,有针对用户、股票、日志、权限等相关的操作，我们在进行接口维护时，可以针对接口进行分类，如果没有对应的分类，我们自己添加分类；

 3). 添加接口

 接口基本信息录入之后，点击提交按钮，就可以看到该接口的基本信息：

 

说明：

通过【编辑】设置请求参数约束信息，比如：参数类型、是否必填、参数描述等；

通过【运行】可设置ip、端口等相关运行环境；

4). 运行接口

Yapi也提供了接口测试功能，当我们接口编辑完毕后，后端服务的代码开发完毕，启动服务，就可以使用Yapi进行接口测试了；

 

注意：访问过程若出现跨域问题，则需要给chrome浏览器安装扩展插件，参考：chrome 安装 yapi 扩展教程.mhtml

在Yapi平台中，将接口文档定义好了之后，前后端开发人员就需要根据接口文档中关于接口的描述进行前端和后端功能的开发；

 

4、Yapi自动同步swagger

 

注意：yapi平台要同步本地stock_backend下的swagger信息时，要保证填写的ip地址能够访问到本地的backend工程，否则同步失效！！

5 、Yapi接口导入导出【了解】

a、 导出接口文档

在Yapi平台中我们不仅可以在线阅读文档，还可以将Yapi中维护的文档直接导出来，可以导出md，json，html格式，在导出时自行选择即可；

 而在导出的html文件或md文件中，主要描述的就是接口的基本信息， 包括： 请求路径、请求方式、接口描述、请求参数、返回数据等信息。展示形式如下：

 

b、 导入接口文档

上述我们讲解了接口文档的导出，我们也可以将外部的接口文档导入到Yapi的平台中，这样我们就不用一个接口一个接口的添加了；

我们可以将课程资料中提供的json格式的接口文档直接导入Yapi平台中来(文档可通过swagger下载)；

 导入过程中出现的确认弹窗，选择"确认"。

 

导入效果：