搭建自己的服务器环境之安装项目文档工具YApi

1. 接口管理工具-YApi

官方仓库地址

1.1 安装

1.1 安装依赖NodeJs

# 创建安装目录
mdkir -p /opt/nodejs
cd /opt/nodejs
# 下载
wget https://nodejs.org/download/release/v12.19.0/node-v12.19.0-linux-x64.tar.gz
# 解压
tar zxvf node-v12.19.0-linux-x64.tar.gz
# 编辑环境变量
vim /etc/profile
# 在/etc/profile最后加入当前安装node的/bin目录
export PATH=$PATH:/opt/nodejs/node-v12.19.0-linux-x64/bin
# 生效环境变量的更改
source /etc/profile
 
# 安装cnpm
npm install -g cnpm --registry=https://registry.npm.taobao.org
 
# 测试
npm -v
node -v
cnpm -v

1.2 安装mongo

YApi的存储依赖于mongo, 参考中间件安装章节的mongo

创建yapi依赖的数据库和用户信息

docker exec -it mongo /bin/bash
mongo -u develop -p xxxx --authenticationDatabase admin
# 使用yapi auth db
use yapi
# 创建用户和角色
db.createUser( {user: "admin", pwd: "123456",roles: [ { role: "dbOwner", db: "yapi" } ]})
 

1.3 启动yapi server

这里启动需要依赖nodejs， 需要安装Nodejs的请参考

# 创建yapi模块包路劲
mkdir -p /opt/YApi
cd /opt/YApi
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

然后按照提示在浏览器完成设置， 注意如果ECS服务器的话，需要放开对应端口

填入表单信息， 注入数据库使用的是上面安装的mongo

1.4 使用pm2管理服务

# 安装pm2
cnpm install pm2 -g
# cd  {部署目录}， 实际看上面在浏览器配置的时候输入的是什么
cd /opt/YApi/my-yapi
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务

按照部署机器的ip和上面部署时的访问端口号，最终访问入口，邮箱为部署时输入的管理员邮箱，默认密码ymfe.org
如果需要中途更改配置信息，如mongo连接地址，可以修改安装目录下的config.json

1.2 使用

使用文档

创建分组，可以将分组理解为一个项目组，一个大的项目中可能会包含多个服务， 然后在这个分组中再创建与项目相关的服务

选择分组，创建项目

点击创建好的项目，可以对项目本身进行细化设置
成员管理， 用来添加成员，这样组内的其他人才能看到这个项目

环境设置，这个对接口调试来说特别有用， 由于项目接口的路径一般分为接口本身的请求路径还有一个就是服务器的http这部分的信息，然后开发环境或者测试环境都是分开的， 但是接口文档却是一样的，那么就可以在这里定义不同环境的请求信息， 然后在接口调试的时候，是可以对维护的环境变量进行选择，然后发送请求进行调试的。而且这里还可以附加固定请求头，比如项目请求有一些固定的请求头，就可以维护在这里，然后在接口调试的时候，发送请求时，这部分请求头就会附加到http请求中

1.3 yapi生成插件

[参考文档]
(https://github.com/diwand/YapiIdeaUploadPlugin/wiki/%E5%BF%AB%E9%80%9F%E4%BD%BF%E7%94%A8)
这个就没有必要自己再写一遍了，直接看参考链接，说的非常详细了

安装插件， 并配合项目配置，来完成目标方法的api自动生成并上传到yapi
这里直接贴出来配置内容

  <component name="yapi">
    <option name="projectToken">db69d613b66841c1947216xxxxxxxxc1c9aeb473bbbad728aeeba7f28ef</option>
    <option name="projectId">14</option>
    <option name="yapiUrl">http://xxxxxxx:8803/</option>
    <option name="projectType">api</option>
    <option name="attachUploadUrl" />
    <option name="returnClass">com.ddf.boot.common.core.response.ResponseData</option>
  </component>

接口上传前

上传方式，插件安装等自行查看上面的链接，同样也是没必要直接搬运

不知道怎么能够让上传的时候这个状态直接是完成，这个界面可以继续编辑数据

接口调试，这里需要安装插件， 没安装的时候这里会有提示，按照提示安装即可