发布API
前提条件
在发布API之前,确保API中已经定义并创建了接口。
操作步骤
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API。单击右上方的 "发布API" 。
在发布API弹出框中配置相关参数,然后单击 "发布" 。
配置项 说明 域名
选择域名进行发布,发布后,可以通过域名访问API。
所属实例
选择所创建的云原生API网关实例。不同的业务环境可用不同的实例区分,实现API在多环境上的发布。
使用场景
使用场景包括基础场景和灰度场景两类。
基础场景
Mock:接口响应将返回接口定义中的Mock配置,若接口未定义Mock配置,则将无法访问该接口。
说明
发布Mock场景时,要求当前API中至少有一个接口开启了Mock配置,否则将发布失败。
单服务:所有流量请求将转发到某一具体的后端服务,这个场景为最常使用的场景。
灰度场景
按比例(多服务):流量将按比例分发到对应的后端服务中,常用于切流及灰度发布场景。
说明
要求服务权重之和等于100。
后端服务
关联该网关实例下的后端服务。
发布描述
填写API的发布描述。
添加API版本
操作步骤
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API,单击右上角的 "更多操作" > "添加版本" ,完成相关配置:
配置项 说明 使用方式 支持Path、Query、Header三种方式。
使用Path时,需要完整访问路径为:
/{域名}/{BasePath}/版本号/接口路径。使用Query时,完整访问路径为:
/{域名}/{BasePath}/接口路径。请求参数中需要添加Query参数,值为版本号。使用Header时,完整访问路径为:
/{域名}/{BasePath}/接口路径。请求头中需要配置添加Header参数,值版本号。
在添加完成后,您可以单击页面上方的 "版本" 下拉框选择版本切换。
导入API
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API。单击右上角的 "更多操作" > "导入" 。
在弹出框中单击 "从文件导入",选择待导入的OpenAPI文件,然后单击 "预检并创建"。
选择 "合并逻辑",各选项说明如下:
选项 说明 智能合并 将在已存在的API基础之上,创建新增的接口,更新重复的接口,但不删除仅在原API中存在的接口。 仅导入新增接口 将在已存在的API基础之上,仅创建新增的接口,对重复或原有的接口不做处理。 覆盖当前API 基于当前导入的文件重新创建API,完全覆盖已有API。 如果预检结果为失败,需要您修改配置文件并重复上述步骤。如果预检结果为成功,可以单击 "创建API" 根据选择的合并逻辑进行API导入 。
导出API
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API。单击右上角的 "更多操作" > "导出" 。
查看发布历史
说明
发布历史保留最近10次
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API,然后单击 "发布历史" 标签页。
单击 "版本" 和 "实例下拉框" 可以选择不同API版本和实例下的发布历史。
单击目标历史版本 "操作" 列下的 "查看" ,可查看历史版本详情。
单击目标历史版本 "操作" 列下的 "切换至该版本" ,可将当前API的在当前实例上的已发布版本切换到选定版本。
下线API
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API。单击右上角的 "更多操作" > "下线" 。
删除API
登录云原生API网关控制台。顶部菜单栏选择 "地域",然后再左侧导航栏选择 "API"。
单击目标API。单击右上角的 "更多操作" > "删除" 。