概述
网关响应是指云原生网关在接收到后端服务的响应后,依据用户配置的响应规则对响应内容进行处理,并将处理后的结果返回给客户端。用户可以在API分组中配置网关响应,启用后,该响应规则会对分组内的所有API生效。
操作步骤
- 登录微服务引擎MSE云原生网关管理控制台,选择资源池。
- 在左侧导航栏,选择云原生网关 > 网关列表,进入对应网关实例的控制台。
- 在左侧导航栏,选择API托管 > 分组管理,进入要查看的API分组详情,即可看到网关响应模块。
新增网关响应
点击网关响应模块内的新增按钮,即可进入网关响应新增弹窗。支持基于模版创建和自定义创建两种方式。响应编码支持200-598,每个分组下,同一个响应编码只能添加一个响应规则。
响应状态码
默认情况下,新建的响应规则会保留后端服务返回的原始响应状态码。如果需要修改响应状态码,可以通过编辑响应规则并填入新的状态码。例如,在413的响应规则中填入500,则客户端接收到的所有413响应都会被替换为500状态码。
响应头
默认情况下,新建的响应规则不会处理响应头。如果需要修改,可以编辑响应规则并添加对响应头的处理逻辑。响应头的处理支持两种操作方式:设置和删除。
· 设置 :若响应头不存在则新增,若已存在则覆盖。
· 删除 :用于移除指定的响应头。
参数值可以是常量、系统参数,或两者的组合。系统参数可以从预定义列表中选择,也可以手动输入,使用**${}** 进行包裹。当匹配到该系统参数时,会自动替换为对应的系统变量值。
响应体
在基于模板创建的响应规则中,默认会将响应内容设置为 JSON 格式,并覆盖后端服务返回的响应内容。响应体处理规则可进行修改,支持两种替换方式:全局替换和规则替换。
全局替换
根据配置的响应类型和具体的响应内容,直接覆盖后端服务返回的完整响应。
规则替换
根据配置的替换规则,对后端服务的响应体进行部分替换。支持使用常量或正则表达式进行匹配,匹配成功后可选择全量替换或仅替换首次匹配项。替换值可以是常量、系统参数,或两者的组合。
启用网关响应
新创建的网关响应规则默认未启用。要使其生效,请点击启用按钮并保存配置。必须配置响应头、响应体或两者,才能启用该规则。
删除网关响应
响应规则支持单个删除和全量删除。当鼠标悬停在某个响应规则上时,会出现红色的删除图标,点击即可单个删除该规则。新增按钮旁边的删除按钮用于删除该分组下的所有响应规则。删除操作不可撤销,请谨慎操作。