YApi 是一个高效、易用、功能强大
的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
特性
-
基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍 -
扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性 -
prf-类似 postman 的接口调试 -
自动化测试, 支持对 Response 断言 -
MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据 -
支持 postman, har, swagger 数据导入 -
免费开源,内网部署,信息再也不怕泄露了
快速上手
获取权限
新用户登录拥有 个人空间
分组下的全部权限,个人空间分组仅自己可见,因此可以在这里任意试用 YApi 的功能。
除此以外没有任何项目或分组的权限,只能浏览已存在分组下面的公开项目。
如果找不到想找的项目,可能是尚未成为项目成员,此时应联系 项目组长
将你加入该项目。
选择项目
如果你已经登录,会在首页右侧看到一些项目 (可以在左侧的分组列表切换分组来查看不同分组下的项目)。
新建接口
点击左侧接口分组右侧的菜单按钮,选择 添加接口
,或者点击接口列表右上角的 添加接口。选择接口分类,输入接口名称和接口路径,点击
提交
。至此已经创建了第一个 YApi 的接口,你可以看到在左侧看到接口名称,右侧有该接口的信息预览。
内网部署
环境要求
nodejs(7.6+)
mongodb(2.6+)
git
安装
使用 yapi 提供的 yapi-cli 工具,部署 YApi 平台是非常容易的。执行 yapi server 启动可视化部署程序,输入相应的配置和点击开始部署,就能完成整个网站的部署。部署完成之后,可按照提示信息,执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定 url, 点击登录输入您刚才设置的管理员邮箱,默认密码为 ymfe.org 登录系统(默认密码可在个人中心修改)。
npm install -g yapi-cli --registry https://registry.npm.taobao.org
yapi server
服务管理
npm install pm2 -g //安装pm2
cd {项目目录}
pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服务
pm2 info yapi //查看服务信息
pm2 stop yapi //停止服务
pm2 restart yapi //重启服务
升级
升级并不会影响已有的项目数据,只会同步 vendors 目录下的源码文件。
cd {项目目录}
yapi ls //查看版本号列表
yapi update //更新到最新版本
yapi update -v {Version} //更新到指定版本
传送门
开源协议:Apache2.0
开源地址:https://github.com/YMFE/yapi
项目合集:https://github.com/OpenTechCol/OpenTechCol
原文始发于微信公众号(开源技术专栏):支持本地部署的可视化的接口管理平台 YApi
版权声明:本文内容由互联网用户自发贡献,该文观点仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 举报,一经查实,本站将立刻删除。
文章由极客之音整理,本文链接:https://www.bmabk.com/index.php/post/155284.html