看看本次版本更新主要涵盖的重点内容,有没有你所关注的功能特性:
- 多分支能力持续升级
- Query 参数支持枚举等高级配置
- 支持自定义快捷键
- 支持全局设置是否允许返回响应里有额外字段
- 支持导入非 API 的 Markdown 文件
- 更多 CI/CD 平台集成
- 环境变量支持实时协作更新
1、多分支能力持续升级
多分支功能自发布后受到了大家的热烈支持。在此基础上,我们持续迭代升级,在本次更新中新增支持「接口用例」、「自动化测试」及「历史记录」功能,提升多分支能力覆盖范围,优化使用体验。
其中,在分支中进行自动化测试编排步骤时,对于在本分支内涉及到的新增/修改的接口,会在最右侧出现蓝色的分支图标,帮助测试人员快速定位相关接口位置。同时,点击带有分支图标的测试步骤详情中的跳转接口文档,会自动跳转至该迭代分支中的接口文档内,而不是跳转至主分支的接口文档内。
更多关于多分支能力升级的内容,可以前往 Apifox 帮助文档「分支」模块查看。
2、Query 参数支持枚举等高级配置
根据用户反馈,除了 Body 参数的 JSON/XML 类型之外,Query 参数、Path 参数、Header 参数、Cookie 参数等全部参数类型,均支持配置枚举、最大值、最小值 、format 等高级属性,兼容 OpenAPI 规范。
除了可视化配置外,Apifox 还支持通过「JSON Schema」编辑器来灵活配置参数属性,满足不同场景需求。
3、支持自定义快捷键
点击 Apifox 右上方的齿轮(设置)按钮,选择「快捷键」查看目前的设置情况,可根据个人习惯和偏好对快捷键组合进行修改,提升个人使用体验。如果有快捷键冲突,可以根据提示进行调整。
需要注意的是,Web 端暂不支持自定义快捷键,需在 Apifox 客户端中进行设置。当设置的快捷键与浏览器内置的快捷键产生冲突时,将优先响应浏览器的快捷键。
更多关于快捷键的内容,可以前往 Apifox 帮助文档「快捷键」模块查看。
4、支持全局设置(是否允许返回响应里有额外字段)
以往 Apifox 的「校验响应」机制比较宽松,始终允许返回响应中包含文档未定义的字段。但对于较为严格的开发场景,需要校验响应时对额外字段有相关提示。
因此,最新版的 Apifox 可以自行选择在校验响应时是否允许出现文档中未定义的字段。可在「项目设置 - 功能设置 - 校验响应设置」中进行配置,设置后对项目内的所有接口生效。
- 开启此功能后,即使返回的响应数据中出现文档中未定义的字段,也不会触发校验错误提示。
- 关闭此功能后,接口实际返回的字段必需与接口响应定义完全一致,任何未定义的额外字段都会导致校验报错,并提示“不允许有额外的属性”。
需要注意的是,仅当接口文档的返回响应的 Object 类型字段"未配置"额外字段时,上述设置才会生效。如果接口文档内已对额外字段进行设置,则以该文档内设置为准。关于额外字段配置的详细内容,可以前往 Apifox 帮助文档「高级数据类型」查看。
5、支持导入非 API 的 Markdown 文件
Apifox 新增支持批量导入 Markdown 文件功能,无需手动复制粘贴,一键即可快速导入。导入的每个文件会作为独立 Markdown 文档保存,不会被转换为接口文档。
6、更多 CI/CD 平台集成
自动化测试支持与更多 CI/CD 平台集成,支持把 Apifox 与 Jenkins、GitLab、GitHub Actions、CircleCI、Bitbucket Pipelines、Travis CI 等第三方工具集成,一键即可复制代码,大幅提升测试人员工作效率,减少人为操作失误。
7、环境变量支持实时协作更新
在本次更新中,环境变量也支持多人在线协作、实时自动更新。当多人同时编辑时,修改并保存环境变量后,新的变量会自动同步给团队内的成员,无需手动全局刷新。当保存内容时发现冲突内容,Apifox 会提供冲突内容细节对比,可以选择双方需要保留的部分内容,也可以选择一方内容全部覆盖。
8、了解更多
当然,Apifox 产品团队为大家带来的新功能远不止上方这些:
- 编辑接口文档时,支持通过 Object 高级设置的额外字段定义 HashMap 或字典数据结构
- 支持在目录树批量导入 JSON Schema 文件为数据模型
- 导出 OpenAPI/Swagger 文件时,可以选择是否将接口的目录导出为 Tags 字段
- 编辑接口文档时,可以把接口数据结构中的节点提取为数据模型
- Markdown 文档新增组件:Hover 文字、嵌入视频
- 快捷请求和自动化测试的自定义请求,可以不使用默认开启的全局参数
- 连接 PostgreSQL 数据库导入数据结构时,可以导入相同名称的表
- 发布的公开文档,可以为亮色/暗色模式配置不同的主题色和 Logo,可以配置是否允许访问者自行切换模式
- 使用 Apifox CLI 命令行工具进行自动化测试时,自动移除 JSON 请求体内的注释
- 导入/导出 Apifox 格式的文件时,会包括责任人字段
- 将鼠标 Hover 到测试报告列表的耗时数字上时,可以展示每个事件的耗时
- 分享的在线文档,无论是否选择了环境,都可以直接在浏览器内调试
- 如果被移出了某团队,再次访问该团队的资源时,界面上会给出明确的提示