概述
云原生网关的API管理集中控制API的路由、流量和安全。用户可以配置API路由规则、请求处理、认证授权等功能,确保高效、安全的访问。
操作步骤
- 登录微服务引擎MSE云原生网关管理控制台,选择资源池。
- 在左侧导航栏,选择云原生网关 > 网关列表,进入对应网关实例的控制台。
- 在左侧导航栏,选择API托管 > API列表。
创建API
API的创建过程分为四个步骤:
1、基本信息
分组:API所属的分组,创建后不可修改。
API名称:可填写API的业务含义。
安全认证:选择API的安全认证方式,开启应用授权后,只有授权的应用才能访问该API。
防重放攻击:开启后,请求头必须包含x-ca-timestamp和x-ca-nonce参数。
2、定义API请求
请求路径(Path):API的访问路径。如果分组设置了BasePath,API的最终访问路径将为BasePath+Path。创建后不可修改。
请求方法(HTTP Method):指定API的请求方式。创建后不可修改。
入参请求模式:支持三种模式,入参映射(过滤未知参数)、入参映射(透传未知参数)、入参透传。
入参定义:支持在query、header、path中定义参数。如果在path中定义了参数,必须确保该参数包含在Path中。
3、定义后端服务
后端服务:负责处理请求的后端服务。
后端请求路径(Path):网关转发请求到后端服务的路径。如果在Path中定义了参数,后端请求路径中必须包含相应参数。
请求方法(HTTP Method):指定请求后端服务的方式。
后端超时:设置请求后端服务的超时时间。
后端服务参数配置:将请求的入参与后端服务的入参一一对应,支持修改请求参数名。
常量参数:可以添加常量参数,并透传到后端服务。
系统参数配置:支持添加系统参数,并透传到后端服务。
4、定义返回结果
这里设置的API返回结果,仅用于生产文档,不会对API的请求、响应产生影响。
API发布
创建或修改API后,不会立即生效,需进行发布操作。API支持多环境管理,发布时需选择要发布的目标环境。
API下线
已发布的API,支持下线操作。点击对应API右侧省略号的下线按钮可进入。
API克隆
API支持复制,会基于当前API,创建一个新的API。
API删除
API支持单个、批量删除操作。已发布的API,需要先下线后,才能进行删除。