部署YApi可视化接口管理平台 基于环境:Linux Cent os + 宝塔
第一步 安装Mongdb&PM2管理器
pm2安装的时候会自动安装npm 和node坏境
在宝塔面板内,点击软件商店,安装Mongdb和PM2管理器。mongodb
创建一个 yapi
的数据库
- 点击宝塔左侧导航栏 安全→增加端口放行:27017
3. 登录阿里云,找到指定的ecs服务器,找到网络与安全组→安全组配置→配置规则→添加安全组规则→放行端口号:27017
一定要在宝塔和阿里云都要放开端口号27017,否者使用类似navicat连接的时候提示,连接失败
第二步 解析域名
找到你的域名服务商,解析对应的域名,如 api.xxx.com
第三步 安装YApi
YApi官网
使用xhsell连接服务器,直接运行下面的命令即可。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
这个时候提示,在浏览器中打开 [http://0.0.0.0:9090](http://0.0.0.0:9090)
访问。……ip换成自己服务器的
开放端口
第四步 添加PM2管理
打开PM2管理器,添加一个启动。
项目根目录:vendors/server/
启动文件名称:app.js
项目名称:自己起个
添加好之后,点击启动即可。
第五步,开启站点映射
点击映射,填入你的域名地址就可以访问了
map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}
server{
listen 80;
server_name yapi.company.com;
charset utf-8;
location / {
proxy_pass http://127.0.0.1:3000;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_http_version 1.1;
proxy_set_header Connection "upgrade";
proxy_set_header Upgrade $http_upgrade;
proxy_read_timeout 120s;
}
location = /favicon.ico {
log_not_found off;
access_log off;
}
}
第六步 扩展配置及插件
配置邮箱
修改跟目录下的config.json文件里面的参数
修改完一定记得要重启一下哈!
全部完成运行效果如上!
安装插件
官网插件地址:[https://yapi.ymfe.org/documents/plugin-list.html](https://yapi.ymfe.org/documents/plugin-list.html)
我们以安装 export-docx-data 数据导出docx文档 为例安装方法如下:
cd {项目目录}
yapi-cli plugin —name yapi-plugin-export-docx-data
安装完成之后,PM2重启一下即可。
第七:禁止注册使用接口添加用户
上述config.json中如果配置了禁用注册,则注册用户使用如下步骤
9.1 登录yapi【参照上述8】
9.2 添加一个项目,名称任意
9.3 修改环境配置
9.4 添加一个接口
注释代码
9.5进入刚创建的接口,输入参数,点击发送即可
9.6 使用abc@venny.cn + 123456登录即可
10.配置自动同步swagger接口数据
10.1进入项目->设置->swagger自动同步
10.2填入swagger同步地址即可
示例:
http://127.0.0.1:8080/v2/api-docs