YApi 接口管理平台

1. YApi安装

1.1 安装 Node.js

检查是否安装成功

% npm -v
% node -v

1.2 安装 MongoDB

具体步骤可查看 https://www.jianshu.com/p/255bf2a6650c
启动MongoDB

source .bash_profile
sudo mongod --dbpath /usr/local/mongodb-7.0.5/data --logpath /usr/local/mongodb-7.0.5/log/mongo.log

2. 安装 YApi

文档地址 https://hellosean1025.github.io/yapi/devops/index.html

2.1 方式一：可视化部署

sudo npm install -g yapi-cli --registry https://registry.npm.taobao.org
sudo yapi server

自动运行可视化部署程序(http://localhost:9090)

部署完成后，切换到部署目录/Users/xing/my-yapi, 输入命令node vendors/server/app.js
成功后访问 http://127.0.0.1:3000

2.2 命令行部署

下载 zip 包解压到 vendors 目录

# 修改配置文件
% cp vendors/config_example.json ./config.json
% cd vendors
% npm install --production --registry https://registry.npm.taobao.org

# 初始化管理员账号成功,账号名："admin@admin.com"，密码："ymfe.org"
% npm run install-server

# 启动服务器，访问 http://127.0.0.1:3000
% node server/app.js

初始管理员账号：admin@admin.com，密码：ymfe.org

2.3 报错处理

问题一：文件赋予权限

sudo chown 777 -R  my-yapi

问题二：报错Error: Cannot find module 'fs-extra'
解决方式 sudo npm install -g fs-extra

npm install 包名称 --save
参数 --save 的作用是在项目下的 package.json 文件记录安装过的依赖包名称，当复制项目到其他机器时，只需运行命令: npm i 就能自动安装项目用到的依赖包
补充：node_modules 默认目录 /usr/local/lib/node_modules

3. 整合 Swagger

3.1 导入 Swagger

登陆 http://127.0.0.1:3000

3.2 接口请求测试