一,什么是Yapi
YApi 是由去哪儿移动架构组推出的一款开源项目,是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。
官网:https://yapi.ymfe.org/,Yapi具有以下功能特性
权限管理
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
可视化接口管理
基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率
Mock Server
易用的 Mock Server,MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
自动化测试(这个我比较关注)
完善的接口自动化测试,保证数据的正确性,支持对 Response 断言
数据导入
接口支持导入 swagger, postman, har 数据格式,方便迁移旧项目
插件机制
强大的插件机制,满足各类业务需求
二、环境 nodejs(7.6+) mongo(2.6+)
1.nodejs安装(这里需要注意下,版本不要用高于12的,否则会导致安装不成功)
sudo apt-get update
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
sudo apt-get install -y nodejs
2.npm安装(最近好像执行了上一步之后,就有npm了?)
sudo apt-get -y npm
3.mongodb安装
sudo apt-get install mongodb
启动mongo
service mongodb start
三、安装yapi
1、采用官方推荐的可视化部署方式
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server

成功执行这两个命令后,根据提示在浏览器中打开页面,
127.0.0.1:9000
若有端口冲突
更改启动端口
vim /usr/local/lib/node_modules/yapi-cli/src/commands/server.js
# 更改端口92行
# 更改端口92行
启动
yapi server
配置部署完成后根据提示启动
node /usr/local/bin/my-yapi/vendors/server/app.jsapp.js
更改配置
/usr/local/bin/my-yapi/config.json
可能有些小伙伴觉得跑起来之后不能后台运行!别着急,已有解决方案了
-
安装pm2
npm i pm2 -g -
切换到yapi的vendors目录 执行pm2 start
pm2 start server/app.js --watch
搞定,转载+自己的优化

本文详细介绍了YApi的用途,如权限管理、接口管理、MockServer和自动化测试等,并提供了在Ubuntu环境下安装YApi的步骤,包括nodejs、npm和mongodb的安装,以及YApi的可视化部署和使用pm2进行后台运行的配置方法。

1769

被折叠的 条评论
为什么被折叠?



