📂
apisix-dashboard
  • 概述
  • FAQ
  • 更新日志
  • 部署
    • 源码
    • Docker
      • 手动构建
      • DockerHub
    • RPM
  • 指南
    • Route
      • 概述
      • 路由列表
      • 创建路由
      • 编辑路由
      • 删除路由
    • Upstream
      • 概述
      • 上游列表
      • 创建上游
      • 编辑上游
      • 删除上游
    • Service
      • 概述
      • 服务列表
      • 创建服务
      • 编辑服务
      • 删除服务
    • Consumer
      • 概述
      • 应用列表
      • 创建应用
      • 编辑应用
      • 删除应用
    • SSL
      • SSL 列表
      • 创建 SSL
      • 编辑 SSL
      • 删除 SSL
    • 全局插件
      • 插件列表
      • 配置插件
  • 最佳实践
    • API 全生命周期
      • API 版本管理
      • API 在线调试
      • API 上下线
      • API 分组管理
  • 附录
    • 版本兼容
    • 疑难排查
Powered by GitBook
On this page
  • 描述与策略
  • 使用

Was this helpful?

  1. 最佳实践
  2. API 全生命周期

API 版本管理

PreviousAPI 全生命周期NextAPI 在线调试

Last updated 4 years ago

Was this helpful?

描述与策略

API 版本管理是指对 API 定义(API Specification)的管理,用于标记一组 API 在某个版本下的状态,API 版本属于管理用字段。在 Apace APISIX 中,我们约定 Route 等同于 API。

处于早期测试版本的 API 是会发生调整的,使用者应当预期到这一情况。一旦 API 发布,若没有特殊情况,不应当被再次修改。若有不向后兼容的修改,应当通知使用者,以确保他/她们能够快速地切换新版本。请注意:通常旧版本接口需要保留一段时间。

使用

本示例将引导您创建一条路由资源,并为其增加 API 版本,创建后在资源列表页进行搜索、查看。

首先,您需要访问资源列表,接着,点击右侧蓝色创建按钮进入创建流程。

点击版本输入框,若已存在版本号,将会展示下拉框供您选择,如上图所示;若无任何版本号或无您所需的版本号,您需要手动输入指定版本号,如 v2:

如上图所示,新创建的版本号 v2 在版本字段中显示。

如您需要根据版本号进行搜索,只需点击搜索区域的版本字段,将展示目前已存在的版本列表。如下图所示:

在本示例中,选择 v2 并点击右侧搜索按钮,将展示搜索结果:

至此,您可以完成 API 版本的管理。

在进入创建步骤1后,您需要参考以补充必要的信息,除此之外,我们将进行版本字段的配置:

其它步骤,请参考,完成所需配置后提交,将返回列表页:

创建路由
创建路由
列表页
步骤1