本文旨在介绍如何通过控制台管理REST API的关键步骤,包括发布、导入导出、下线API等操作。您还可以在控制台中一键生成 SDK 及其使用文档,从而高效地管理和集成 API,提升开发流程的便利性。
发布API
前提条件
在发布API之前,确保API中已经定义并创建了接口。
操作步骤
云原生API网关提供了实例内和实例外两种发布API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上方的发布。
在发布API面板中配置相关参数,然后单击发布。
配置项
说明
域名
选择对应的域名进行发布,发布后,支持通过相关域名访问API。
若无域名,可单击添加域名,具体操作,请参见创建域名。
所属实例
选择所创建的云原生API网关实例。不同的业务环境可用不同的实例区分,实现API在多环境上的发布。
使用场景
使用场景包括基础场景和灰度场景两类。关于目标服务不同类型说明,请参见路由。
基础场景
Mock:接口的响应将返回接口定义中的Mock配置,若接口未定义Mock配置,则将无法访问该接口。
说明发布Mock场景时,要求当前API中至少有一个接口开启了Mock配置,否则将发布失败。
单服务:所有流量请求将转发到某一具体的后端服务(最常使用的场景)。
灰度场景
按比例(多服务):所有的流量将按比例分发到对应的后端服务中,常用于切流及灰度发布场景。
说明要求多个条目的服务权重之和等于100。
按内容(多服务):所有的流量将按照匹配条件分发到对应的后端服务中,若匹配条件勾选默认,则无其他匹配规则命中时,流量将进入该条目所对应后端服务。
匹配条件支持:等于、前缀是、正则匹配。
参数类型支持:Query、Header。
多个匹配条件之间为“且”运算逻辑。
重要要求多个条目中,只允许一个条目勾选默认,且其余条目的匹配条件非空。
标签路由(按比例):标签路由场景,所有流量将按比例分发到多个后端服务的多个版本。全链路灰度场景下推荐优先使用单服务路由,以获得更好的性能与体验。
后端服务
关联该网关/VPC下的后端服务。若该网关下无后端服务,可单击创建服务创建,具体操作,请参考创建服务。
发布描述
填写API的发布描述。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上方的发布,在发布API面板中配置相关参数,然后单击发布。
配置项
说明
实例
所创建的云原生API网关实例。不同的业务环境可用不同的实例区分,实现API在多环境上的发布。
所属VPC
实例接口所属VPC。
发布范围
API级接口发布范围,可以选择接口名称查看受影响接口详情。
发布描述
填写API的发布描述。
添加API版本
目前只有实例外创建的API支持添加版本。
登录云原生API网关控制台。在左侧导航栏,选择API,并在顶部菜单栏选择地域。
单击目标API,单击右上角的
,完成相关配置:配置项
说明
使用方式
支持Path、Query、Header三种方式。
说明选择使用方式为Query时,需要配置参数项添加Query。
选择使用方式为Header时,需要配置参数项添加Header。
使用Path时,需要添加完整访问路径为:/API基本路径/版本号/接口路径。
使用Query时,完整访问路径为:/API基本路径/接口路径,请求参数中需要配置参数项添加Query为版本号。
使用Header时,完整访问路径为:/API基本路径/接口路径,请求头中需要配置参数项添加Header为版本号。
(可选)在添加完成后,您可以单击页面上方的版本以进行版本切换。
查看历史版本
发布历史保留最近10次。
云原生API网关提供了实例内和实例外两种查看历史版本的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API,然后单击发布历史页签。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API,然后单击发布历史页签。
单击目标历史版本操作列下的查看,可查看历史版本详情。
生成SDK与文档
云原生API网关提供了实例内和实例外两种生成SDK与文档的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上角的
。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上角的
。
在SDK&文档生成对话框中,配置相关参数,然后单击生成并下载。
配置项
说明
API版本
选择要生成SDK与文档的API版本。
说明实例内创建API无版本管理能力,无该选项。
实例外创建API选择是否启用API版本管理能力。若创建API时未启用版本管理,则无该选项。
SDK语言
目前支持的SDK语言:Java、Golang、Python、Node.js、TypeScript、Swift。
等待生成SDK及相关文档后,浏览器将自动下载SDK及相关文档的压缩包至您的本地计算机,您可以到浏览器默认下载路径中进行查看。
说明解压完成后,您可以参考
README.md
文档作为SDK的使用指南,该文档包含了使用SDK所需的基本信息。
导入API
云原生API网关提供了实例内和实例外两种导入API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上角的
。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上角的
。
在基于OpenAPI创建文件面板中配置相关参数,然后单击预检并创建。
导出API
云原生API网关提供了实例内和实例外两种导出API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上角的
。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上角的
。
在导出对话框中,单击确认。浏览器会将API下载至本地默认下载路径中。
下线API
下线后,所有相关域名将无法访问该API下的接口。虽然API实例将停止处理请求,但其配置和历史记录仍会保留在系统中,请谨慎执行此操作。
云原生API网关提供了实例内和实例外两种下线API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上角的
。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上角的
。
在确认下线对话框中,单击下线。
删除API
若当前API存在已发布的实例,需所有实例下线后再进行删除操作。
删除API将彻底移除API的配置、文档和历史记录,且不可恢复,请谨慎执行此操作。
云原生API网关提供了实例内和实例外两种删除API的方式:
实例外API
登录云原生API网关控制台。左侧导航栏选择API,并在顶部菜单栏选择地域。
单击目标API。单击右上角的
。
实例内API
登录云原生API网关控制台。左侧导航栏选择实例,并在顶部菜单栏选择地域。
在实例页面,单击目标网关实例ID。左侧导航栏选择API,单击目标API。
单击右上角的
。
在确认删除对话框中,单击删除。