开放 API 是技术团队向外部提供服务和数据的关键手段。随着业务的发展和技术的更新,API 也需要不断进行版本迭代。这种迭代通常是为了满足市场需求,优化现有功能,增加新特性,或者修复漏洞。
在多个版本共存的情况下,团队需要确保每个版本都能满足不同用户的需求。例如,某些用户可能需要使用最新版本的 API 来获取最新的功能,而另一些用户则可能依赖于旧版本的稳定性。
在实际应用中,团队可能需要同时向外部提供多个版本的 API,如最新版、稳定版、或长期维护版等。这样可以保证不同用户群体在使用 API 时的兼容性和稳定性,减少因版本升级对旧版用户造成的影响。
基于这样的场景,Apifox 推出了实用的「API 版本」功能。通过该功能,团队可以轻松创建、管理和维护不同版本的 API,确保每个版本的 API 都能独立运作,并与其他版本保持清晰的区分。
下面就来介绍一下 Apifox 中「API 版本」的使用,在使用该功能之前,请确保将 Apifox 更新到了最新版!
创建 API 版本
进入项目后,点击项目目录上方的分支切换组件,选择「API 版本」,即可查看当前项目的所有 API 版本。点击「新建 API 版本」,可为其命名并选择初始内容。
保存后,系统会自动切换到新版本。你可以独立编辑这个版本中的资源,这些修改不会影响原来的版本。
在公开文档中发布 API 版本
在项目中创建 API 版本后,你可以进入「分享文档 -> 发布设置」页面,选择你想要发布的 API 版本。发布设置完成后,所选 API 版本会在项目的公开地址中展示,外部用户可以通过该地址进行访问。
点击「添加」按钮,选择你想发布的 API 版本,可以设置版本的来源、显示版本号、运行环境以及 Slug。
标签:迭代,用户,API,版本,Apifox,分支 From: https://blog.csdn.net/m0_58552717/article/details/141504835