Apifox 12 月更新 | 新增接口唯一标识功能
12 月,Apifox 又为你带来了新惊喜。从提升产品体验及 API 协作效率角度出发,我们近一个月以来上线了大量新功能和新特性。
本期产品更新重点关注:
- 在项目的功能设置中,可以将响应示例优先配置为默认 Mock 方式
- 测试报告中的步骤,支持跳转到接口调试
- 新增接口唯一标识功能
- 项目内可快捷邀请团队成员
- 数据库操作新增支持 ClickHouse 和达梦数据库
- 改进了引用数据模型的选择体验
默认 Mock 优先响应示例
Apifox 初始设置的默认 Mock 方式是智能 Mock,每次运行生成的数据是随机的。但如果需要每次返回的数据是固定值,可以选择将响应示例优先设置为默认 Mock 方式。在项目的功能设置中选择「响应示例优先」即可,设置后会优先按设置的响应示例显示。
当然,如果设置了高级 Mock 期望,那无论如何都是高级 Mock 期望的优先级最高。
当需要设置多个响应示例的时候,可以直接将接口文档的响应示例添加为高级 Mock 的期望,无需手动填写,帮助大家节省更多时间精力去做更重要的事。
可以点击「响应示例」右侧的 M 字按钮直接添加:
也可以在新建期望时,在「自动生成」里选择使用示例值:
测试报告中的步骤支持快速调试
在自动化测试步骤运行完成后,经常会遇到某条步骤报错,需要快速定位具体错误原因的情况。
我们在接口运行结果界面新增了调试按钮,支持快速调试该步骤,并保留当时接口报错时返回的响应,节省复制时间,提高测试效率。
调试完成后点击保存可以立即更改步骤内容。
新增接口唯一标识功能
我们在 OpenAPI 规范基础上改进了接口的唯一标识规则,以适应部分用户在调用电商、支付类业务时目标服务以同一个 URL 地址指向多个方法的情景。
为了让该场景下的用户更便捷管理,我们为接口配置了接口唯一标识,除 Method & Path 外,新增以 operationId、Query 参数、Body 参数、Header 参数来区分接口,保证使用同个 URL 接口场景的团队能更顺滑使用 Apifox 进行协作与管理,避免出现在 API 数据导入导出时可能会出现接口覆盖等情况。
举个例子:假设我们有一个电商网站,其中有个接口用于 ERP 订单信息同步,为了更好地调用和管理这个接口,我们可以将 Query 参数设置为接口唯一标识, 参数设置为 action,参数值填写为 .erp.order.sync ,我们就可以使用这个唯一标识来区分接口了。
使用只需两步:
- 在「目录设置」中定义唯一标识及对应参数名,创建接口文档时便会显示该字段。
- 开发人员在编写文档时,填写对应唯一标识值即可。
更多有关接口唯一标识的内容可以前往官网更新日志查看。
项目内可快捷邀请团队成员
可以直接从列表选择已在团队内的成员加入项目,并且可以同步设置成员权限,提高团队内部协作效率。
数据库操作支持新的数据库类型
数据库操作现新增了对 ClickHouse 数据库及达梦数据库的读写支持,查询结果可在接口请求参数、断言、自定义脚本等场景中使用。
目前 Apifox 的数据库操作支持包括:MySQL、SQL Server、Oracle、PostgreSQL、ClickHouse 以及达梦数据库。
改进了引用模型的选择体验
在引用数据模型时,弹窗模式下支持搜索功能,便于用户进行快速查找。
了解更多
此外,Apifox 产品团队积极回应用户呼声,还带来了以下改进:
- 普通成员支持项目数据导出
- API 创建表格编辑器全面升级
- 接口筛选器新增了状态、标签和负责人的数量统计显示
- 分享的 API 文档支持配置自定义字段显示
- 克隆项目能力支持测试用例和测试套件数据
- 连接 MySQL 数据库时,支持使用 SSH 隧道
- 可以切换接口显示为 “名称” 还是 “URL”
- 在线分享的文档链接,支持复制带密码的链接,不需要手动输入密码
- 在线文档支持配置顶部导航右侧功能区的图标和文字链接,以及顶部的通知
- URL Encode 支持 RFC 3986 和 WHATWG 2 种规则
- 可以使用快捷键 ⌘/Ctrl+D 复制目录和文件
除了新增功能,我们也对产品细节和使用体验上进行了优化,可以前往 Apifox 官网更新日志查看。
欢迎各位用户对 Apifox 继续提出使用反馈和优化意见,我们会持续优化更新,致力于为用户提供更优秀的产品功能和更极致的使用体验!
可以前往帮助文档查看更多使用说明和操作,有任何问题欢迎在 Apifox 用户群与我们交流沟通。