Apifox 8月更新|多版本 API 文档、Dubbo 支持前后置操作、定时导入优化、 测试场景单独通知

多版本 API 文档、Dubbo 支持前后置操作、定时导入优化、 测试场景单独通知

Apifox 新版本上线啦!

看看本次版本更新主要涵盖的重点内容,有没有你所关注的功能特性:

  • 「多版本」API 文档
  • Dubbo 项目支持前后置操作
  • 「定时导入」能力升级
  • 测试场景支持单独设置通知
  • 通用 Runner 支持自定义设置
  • 组织与 SSO
  • 支持将「个人团队」移动到「组织」
  • 可通过链接或邮箱邀请加入「组织」
  • 可为个人访问密钥配置 SSO 来访问组织资源
  • 用户反馈优化
  • 回收站支持彻底删除
  • 导入 Swagger/OpenAPI 文件时删除不存在的资源
  • 生成代码时,动态值会被替换为实际的值
  • 自动重新校验响应
  • 弹窗内支持「格式化」

将 Apifox 更新至最新版,一起开启全新体验吧!

「多版本」API 文档

HTTP 项目新增 API 版本管理能力,支持创建与管理接口的不同版本,包括全量的 HTTP 接口、数据模型、响应组件、Markdown 文档资源,确保每个版本的 API 都能独立编辑且相互区分。

同时,可以发布或在线分享不同版本的 API 文档,保证不同用户群体在使用 API 时的兼容性和稳定性,减少因版本升级对旧版用户造成的影响,维护良好的用户体验和系统稳定性,方便与团队或客户协作。

更多关于多版本的内容可以查看往期推文:《API 的多版本管理,如何在 Apifox 中操作?

「多版本」API 文档



Dubbo 项目支持前后置操作

使用最新版本的 Apifox 调试 Dubbo 项目在接口时,可以基于响应定义自动校验响应,也支持执行前/后置操作,包括断言、提取变量、数据库操作、自定义脚本、公共脚本、等待时间等,逐步增强 Dubbo 项目的开发能力,使 Dubbo 调试变得更加高效和便捷。

Dubbo 项目支持前后置操作


定时导入」能力升级

通过自托管 Runner 执行的导入数据任务支持立即运行,快速验证接口是否正确导入,无需等待预设时间。导入频率可以配置为最短「每隔 5 分钟」触发一次,满足对数据实时性要求较高的场景需求。同时,新增对 YApi 格式数据的定时导入支持,方便从不同平台迁移或同步数据,扩大了兼容性范围。

「定时导入」能力升级


测试场景支持单独设置通知

我们对通知功能进行了升级,单次触发可同时通知多个对象,确保重要信息的及时传递,提高信息传递效率。同时每个测试场景支持独立设置通知,实现精细化的通知控制,避免信息干扰,提高团队沟通效率和项目管理的精准度。

测试场景支持单独设置通知



通用 Runner 支持自定义设置

部署通用 Runner 时,支持自定义服务器 OS、暴露端口、挂载数据目录等设置,更好地满足各种复杂环境和特定需求。配置后会自动生成生成对应的 Docker 命令,简化部署流程。

通用 Runner 支持自定义设置


组织与 SSO

支持将「个人团队」移动到「组织」

在「组织」的团队管理页面,新增支持将「个人团队」移动到「组织」内,使团队结构调整更加便捷,为组织管理提供更大的灵活性,但有两点需要注意:

  1. 只有权限为「团队所有者」的现有个人团队才能被转入组织
  2. 一旦团队转入组织,将无法再转出
支持将「个人团队」移动到「组织」

可通过链接或邮箱邀请加入「组织」

在「组织」的成员管理页面,可以选择通过「链接邀请」或「邮箱邀请」两种方式邀请他人加入组织,使管理者能够根据具体需求和场景按需选择最合适的邀请方式。

需要注意的是,通过「组织」成员管理页面邀请的成员在加入组织后初始不属于任何团队,管理者需要手动将新加入的成员分配到相应的团队中。

可通过链接或邮箱邀请加入「组织」

可为个人访问密钥配置 SSO 来访问组织资源

用户加入了已开启 SAML 单点登录(SSO)的「组织」后,可以为「个人访问密钥」配置 SSO,用户直接使用密钥访问组织内的资源,确保了资源访问的一致性和安全性,使组织能够更好地控制和监管成员对资源的访问,为团队协作提供了更安全、更高效的环境。

用户反馈优化

回收站支持彻底删除

根据大家反馈的建议,我们对回收站功能进行了升级。现在,你可以在回收站内彻底删除接口、数据模型等资源,为项目管理提供更强更完善的控制能力。

回收站支持彻底删除


导入 Swagger/OpenAPI 文件时删除不存在的资源

导入 Swagger/OpenAPI 文件时,可以删除不在数据源中的资源,包括接口、数据模型,使两边的数据对齐,简化了 API 文档的维护流程,提高项目的整体一致性和准确性。

导入 Swagger/OpenAPI 文件时删除不存在的资源


生成代码时,动态值替换为实际的值

根据用户反馈,在生成代码时,我们将包含 {% mock ... %} 的动态值部分替换为实际的值,提高了生成代码的实用性,使其可以直接运行,无需额外修改,提升使用体验感。

生成代码时,动态值替换为实际的值



自动重新校验响应

调试接口、用例时,切换文档定义的返回响应后,会立即重新校验响应,无需手动重新发送请求,节省不必要操作和时间,提升使用体验。

弹窗内支持「格式化」

在弹窗内编辑 form-data 等参数的值时,可以点击「格式化」对 JSON、XML 等内容进行格式美化,自动调整缩进和换行,使复杂的数据结构更易于阅读和理解,提高可读性。

编辑 form-data 等参数的值时,可以点击「格式化」对 JSON、XML 等内容进行格式美化


了解更多

当然,Apifox 产品团队为大家带来的新功能远不止上方这些:

  • 支持创建通用接口文档来管理自定义协议的文档,可以配置协议名称和唯一标识,支持在线分享
  • Markdown 文档新增组件:嵌入,可以在文档内嵌入第三方网页内容
  • Auth 支持 Kerberos
  • 导出数据选择要包含的内容范围时,可以通过标签筛选 Markdown 文档
  • 可以配置接口目录在「在线文档」中的展示方式,可选项为普通目录、模块标题、跳转到子目录
  • 在团队的订单管理页面,可以查看定时任务的用量
  • 导入 Swagger/OpenAPI 文件时,可以配置当 summary 为空时,优先使用 operationId、path 作为接口名,还是优先从 descrption 中提取接口名
  • 调试接口、用例时,在发送请求之前,默认折叠返回响应区域;如果光标在地址栏内,可以直接通过回车键发送请求
  • Markdown 文档的大纲内的英文单词,不再会被截断
  • 当引用的测试场景被 Fork 到子分支时,会使用子分支的资源来运行
  • 导入 Markdown 文档时,如果目录和名称都相同,则视为同名文件
  • 分享在线文档时,可以选择 Runner 的 Mock 环境
  • 在测试报告页面,可以直接再次运行对应的测试场景

除了新增功能,我们也对产品细节和使用体验进行了优化,具体修改内容可前往 Apifox 更新日志查看

欢迎各位用户对 Apifox 继续提出使用反馈和优化意见,我们会持续优化更新,致力于为用户提供更优秀的产品功能和更极致的使用体验!

可以前往帮助文档查看更多功能使用说明和操作,有任何问题欢迎在 Apifox 用户群与我们交流沟通。

订阅
qrcode

订阅

随时随地获取 Apifox 最新动态