文档

管理API版本

更新时间:

REST API支持版本管理,本文介绍如何通过控制台添加API版本,并切换至目标API版本。

前提条件

已完成REST API创建并添加接口。具体操作,请参见创建REST API并添加接口

使用背景

在REST API中进行版本管理是一项重要的实践,它有助于保持API的向后兼容性,并简化未来的维护和升级。它允许API随着时间的推移而演化,同时保持对旧版本的支持。

添加API版本

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,单击API管理,并在顶部菜单栏选择地域。

  3. 在API列表中,单击目标API,进入目标API详情页,单击页面右上角的更多操作 > 添加版本

  4. 配置版本信息,并单击确认进行添加。

    配置项

    说明

    版本号

    相同API名称下,以版本号进行区分。

    使用方式

    支持PathQueryHeader三种方式。

    说明
    • 选择使用方式Query时,需要配置参数项添加Query

    • 选择使用方式Header时,需要配置参数项添加Header

    • 使用Path时,需要完整访问路径为:/API基本路径/版本号/接口路径。

    • 使用Query时,完整访问路径为:/API基本路径/接口路径,请求参数中需要配置参数项添加Query为版本号。

    • 使用Header时,完整访问路径为:/API基本路径/接口路径,请求头中需要配置参数项添加Header为版本号。

切换API版本

  1. 登录云原生API网关控制台

  2. 在左侧导航栏,选择API管理,并在顶部菜单栏选择地域。

  3. 在API列表中,单击目标API,进入目标API详情页,单击页面左上角的版本进行切换。

    image