微服务引擎MSE

头部重写header-rewrite插件

2025-05-27 07:56:09

描述

header-rewrite插件可以对请求/响应头部的header参数进行新增、修改和删除操作.

作用范围

该插件只能用于路由级插件,因为每条路由请求/响应头部的header参数不同,要视具体情况而定。

属性

名称

类型

必选项

默认值

有效值

描述


request

Object

可选

修改请求header,支持新增、修改、删除操作



add

Array<Object>


新增操作, 当存在目标header key时,末尾追加值;否则,新增一个header;header   key和header value不可同时为空。



update

Array<Object>


更新操作, 当存在目标header key时,更新header值;否则,新增一个header;header key和header value不可同时为空。



delete

Array<String>

 


删除操作, 当存在目标header key时,删除目标header;否则忽略;


response

Object

可选

修改响应header,支持新增、修改、删除操作



add

Array<Object>


新增操作, 当存在目标header key时,末尾追加值;否则,新增一个header;header   key和header value不可同时为空。



update

Array<Object>


 

更新操作, 当存在目标header key时,更新header值;否则,新增一个header;header key和header value不可同时为空。



delete

Array<String>


删除操作, 当存在目标header key时,删除目标header;否则忽略;


 

支持的类型:

● request,请求头部类型

● response,响应头部类型

允许的操作:

新增:增加一个头部

修改:存在则更新;不存在则增加

删除:去掉一个指定key,不需要指定value

如何使用

在配置窗口页以 YAML 格式填写

配置示例

模板参考

# 修改请求header,支持新增、修改、删除操作,操作类型不为空时,其目标header key也不能为空

request:

  # 新增操作,当存在目标header key时,末尾追加值;否则,新增一个header

  add:

    num: 123

    name: "cgw"

  # 更新操作,当存在目标header key时,更新header值;否则,新增一个header

  update:

    num: 234

    name: "CGW"

  # 删除操作,当存在目标header key时,删除目标header;否则忽略

  delete:

    - id

    - name

# 修改响应header,支持新增、修改、删除操作,操作类型不为空时,其目标header key也不能为空

response:

  # 新增操作,当存在目标header key时,末尾追加值;否则,新增一个header

  add:

    num: 123

    name: "cgw"

  # 更新操作,当存在目标header key时,更新header值;否则,新增一个header

  update:

    num: 234

    name: "CGW"

  # 删除操作,当存在目标header key时,删除目标header;否则忽略

  delete:

    - id

    - name

启用/停用

在配置页面设置生效开关

验证插件

请求接口,若发现已返回header发生变更,代表插件已经生效。


TgLrse1BrlAx