自定义应答

功能说明

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

配置字段

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

配置示例

Mock 应答场景

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

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

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

触发限流时自定义响应

  1. enable_on_status:
    - 429
    status_code: 302
    headers:

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

  1. HTTP/1.1 302 Found

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

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

对特定路由或域名开启

  1. # 使用 matchRules 字段进行细粒度规则配置
    matchRules:
    # 规则一：按 Ingress 名称匹配生效
    - ingress:
      - default/foo
      - default/bar
      body: “{\”hello\”:\”world\”}”
    # 规则二：按域名匹配生效
    - domain:
      - “*.example.com”
      - test.com
      enable_on_status:
      - 429
      status_code: 200
      headers:
      - Content-Type=application/json
      body: “{\”errmsg\”: \”rate limited\”}”

此例 ingress 中指定的 default/foo 和 default/bar 对应 default 命名空间下名为 foo 和 bar 的 Ingress，当匹配到这两个 Ingress 时，将使用此段配置； 此例 domain 中指定的 *.example.com 和 test.com 用于匹配请求的域名，当发现域名匹配时，将使用此段配置； 配置的匹配生效顺序，将按照 matchRules 下规则的排列顺序，匹配第一个规则后生效对应配置，后续规则将被忽略。