文档首页/ 应用与数据集成平台 ROMA Connect/ 用户指南/ 服务集成指导（旧版界面）/ 插件管理/ HTTP响应头管理插件说明
更新时间：2022-09-02 GMT+08:00
查看PDF
分享

HTTP响应头管理插件说明

概述

HTTP响应头是API响应中的一部分。HTTP响应头管理插件提供了自定义HTTP响应头的能力，并在API响应中返回自定义的响应头。

使用限制

  • ROMA Connect增加的系统响应头（x-apig-*、x-request-id等）不支持修改。
  • 跨域资源共享（CORS）功能增加的响应头不支持修改。

配置参数说明

表1 配置参数

参数

配置说明

Name

响应头名称。每个插件中不能添加重复名称的响应头（不区分大小写）。

Value

响应头的值。当“Action”为“Delete”时响应头的值不生效，可为空。

Action

响应头操作，您可以覆盖、添加、删除、跳过或新增指定的响应头。

  • Override：覆盖
    • 当API响应中存在指定的响应头时，使用当前响应头的值覆盖已有响应头的值。
    • 当API响应中存在多个与指定响应头相同名称的响应头时，只会按当前响应头的值返回一条响应头记录。
    • 当API响应中不存在指定的响应头时，添加当前响应头。
  • Append：添加
    • 当API响应中存在指定的响应头时，将当前响应头的值添加到已有响应头的值之后，值之间用“,”分隔。
    • 当API响应中存在多个与指定响应头相同名称的响应头时，会将多个响应头的值用“,”拼接后，再添加当前响应头的值。
    • 当API响应中不存在指定的响应头时，添加当前响应头。
  • Delete：删除
    • 当API响应中存在指定的响应头时，删除当前响应头。
    • 当API响应中存在多个与指定响应头相同名称的响应头时，删除所有相同名称的响应头。
  • Skip：跳过
    • 当API响应中存在指定的响应头时，跳过当前响应头。
    • 当API响应中存在多个与指定响应头相同名称的响应头时，均不作处理直接返回。
    • 当API响应中不存在指定的响应头时，添加当前响应头。
  • Add：新增

    无论API响应中是否存在指定的响应头，都添加当前响应头。

脚本配置示例

{
  "response_headers": [
    {
      "name": "header1",
      "value": "test",
      "action": "append"
    },
    {
      "name": "header2",
      "value": "roma",
      "action": "override"
    }
  ]
}
父主题： 插件管理

相关文档