功能说明

custom-response插件支持配置自定义的响应，包括自定义 HTTP 应答状态码、HTTP 应答头，以及 HTTP 应答 Body。可以用于 Mock 响应，也可以用于判断特定状态码后给出自定义应答，例如在触发网关限流策略时实现自定义响应。

运行属性

插件执行阶段：认证阶段 插件执行优先级：910

配置字段

名称数据类型填写要求默认值描述
status_codenumber选填200自定义 HTTP 应答状态码
headersarray of string选填-自定义 HTTP 应答头，key 和 value 用=分隔
bodystring选填-自定义 HTTP 应答 Body
enable_on_statusarray of number选填-匹配原始状态码，生成自定义响应，不填写时，不判断原始状态码

配置示例

Mock 应答场景

  1. status_code: 200
  2. headers:
  3. - Content-Type=application/json
  4. - Hello=World
  5. body: “{\”hello\”:\”world\”}”

根据该配置，请求将返回自定义应答如下：

  1. HTTP/1.1 200 OK
  2. Content-Type: application/json
  3. Hello: World
  4. Content-Length: 17
  7. {“hello”:”world”}

触发限流时自定义响应

  1. enable_on_status:
  2. - 429
  3. status_code: 302
  4. headers:

触发网关限流时一般会返回 429 状态码，这时请求将返回自定义应答如下：

  1. HTTP/1.1 302 Found

从而实现基于浏览器 302 重定向机制，将限流后的用户引导到其他页面，比如可以是一个 CDN 上的静态页面。

如果希望触发限流时，正常返回其他应答，参考 Mock 应答场景配置相应的字段即可。