本文最后更新于 2024-03-14，文章内容可能已经过时。

ubuntu18.04.3 LTS 安装 YAPI -一个瞎折腾的前端搬砖工

01介绍下(复制文档的)

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

02特性 (复制文档的)

  • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍

  • 扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性

  • 类似 postman 的接口调试

  • 自动化测试, 支持对 Response 断言

  • MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据

  • 支持 postman, har, swagger 数据导入

  • 免费开源，内网部署，信息再也不怕泄露了

03环境配置

01- nodejs版本 node的版本为 v10.19.0

hanya@deleigege:~$ node -v 
v10.19.0

02- mongodb安装 启动mongo

$ sudo apt-get install mongodb
$ service mongodb start

03 -错误：Failed to start mongod.service: Unit not found

①创建配置文件：
sudo nano /etc/systemd/system/mongodb.service


②在里面追加文本：


[Unit]
Description=High-performance, schema-free document-oriented database
After=network.target


[Service]
User=mongodb
ExecStart=/usr/bin/mongod --quiet --config /etc/mongod.conf


[Install]
WantedBy=multi-user.target


③按ctrl+X退出
④启动服务


$ sudo systemctl status mongodb
$ sudo systemctl enable mongodb

04 安装yapi

$  npm install -g yapi-cli --registry https://registry.npm.taobao.org
# 我的需要权限 看自己的情况   sudo
 sudo chown -R 1000:1000 "/home/hanya/.npm"
启动 
$ yapi server

可视化部署方式

差不多就这这样了

有朋友是私信，出现了错误了，问题是pass option { useUnifiedTopology: true } to the MongoClient constructor.

Error: (node:90198) DeprecationWarning: current Server Discovery and Monitoring engine is deprecated, and will be removed in a future version. To use the new Server Discover and Monitoring engine, pass option { useUnifiedTopology: true } to the MongoClient constructor.

但是我的系统正常的，也许是配置原因吧，我又用我的服务器(阿里云的)重新安装配置了下。果然报错了。我的服务器是ubuntu16的。

解决方法

cd ~/my-yapi/vendors/ server/utils/
vim  db.js

添加 useUnifiedTopology: true

下面的的初始化管理员账号失败我不知道为啥。我的可以

https://www.icode9.com/content-4-636237.html

这兄弟的是带图的，问题一样

https://www.cnblogs.com/superhin/p/12340560.html

node my-yapi/vendors/server/app.js

这样算成功了

--来吧让我们快乐的搬砖吧--

好吧，这应该是最后一步了，需求是后台运行…..

pm2安装

npm install -g pm2

找到你的项目目录，我是放在根目录下的，这个需要看你的安装路径

例如：my-yapi/vendors/server/app.js

开启服务：pm2 start my-yapi/vendors/server/app.js

关闭服务：pm2 stop /usr/local/my-yapi/vendors/server/app.js

 

 

05YApi 复制文档的

接口的东西有很多，百度下可以看到很多成熟的测试接口的工具，我就是在百度查找，第一个就是Yapi所以就选择这个，如果说这工具有什么好处，我还真不知道，我也就用过几次而已。

安装教程

首页

登录后进入首页，首页展示了分组与项目。

此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。

  • 1首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

  • 2首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

  • 3首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

  • 4点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看。

项目页

点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。

此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。

  • 1项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

  • 2点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

  • 3点击左侧的 “测试集合” 使用测试集功能。

  • 4点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

  • 5点击二级导航的“动态”，即可查看项目的操作日志。

06 权限

分组组长 的权限包括修改分组、删除分组、创建分组下的项目。一般来说，分组组长 只需要对项目负责，将项目的操作任务安排给 项目组长 处理即可。

07 项目操作

03-1添加项目

在新建项目页，填写项目信息：

项目名称不允许重复，包括其他分组

接口为基础路径，默认为根目录（可以选择默认，其他详细配置环境配置、项目图标等需要进入项目页的“设置”面板进行配置。）

我们就是为了自己使用，其他配置能够完成基本的使用

08 接口操作

  • 接口路径：可以更改 HTTP 请求方式，并且支持 restful 动态路由，例如 /api/{id}/{name}, id和name是动态参数

  • 选择分类：可以更改接口所在分类

  • 状态：用于标识接口是否开发完成。

  • Tag：用于标识接口tag信息（v1.3.23+）,在接口list页可以根据tag过滤接口

Quey

json

在预览tab标签下，就会出现相关的数据(我是瞎写的，并不符合json书写规范)

Postman

yapi也同同样支持测试，tab运行 安装谷歌插件

分享 其实谷歌市没那么麻烦，需要的自己百度。

yapi 插件安装

---欧克，让我们快乐的板砖吧--