如何让openapi-generator自动为客户端请求添加固定Header？

你当前的OpenAPI配置仅定义了Header的基础属性，代码生成器仍会将其识别为需要外部传入的参数。要让客户端库自动硬编码该Header值，需修改配置，补充生成器识别固定参数的关键字段：

修改后的OpenAPI参数配置 #

{
  "name": "X-CUSTOM-HEADER",
  "in": "header",
  "schema": {
    "type": "string",
    "enum": ["FIXED_VALUE"]
  },
  "required": true,
  "default": "FIXED_VALUE",
  "x-codegen-ignore": true
}

配置说明 #

• default: 指定Header的固定取值，明确告知生成器该参数的默认值为FIXED_VALUE
• x-codegen-ignore: 标记该参数无需暴露为方法的输入参数，生成器会自动在客户端代码中硬编码这个Header

如果使用OpenAPI Generator，也可以用专属扩展字段x-codegen-fixed-value替代default，效果一致：

{
  "name": "X-CUSTOM-HEADER",
  "in": "header",
  "schema": {
    "type": "string",
    "enum": ["FIXED_VALUE"]
  },
  "required": true,
  "x-codegen-fixed-value": "FIXED_VALUE",
  "x-codegen-ignore": true
}

注意：不同代码生成工具的扩展字段可能略有差异，若上述配置不生效，可查看对应工具的文档确认固定参数的专属标识。

内容的提问来源于stack exchange，提问作者Prashant