使用open-api-maven-plugin时如何排除指定参数不生成到客户端Jar？

针对你遇到的Test-Token头部参数无法排除的问题，可尝试以下几种实用方案：

方案1：使用参数级忽略扩展 #

直接在目标参数中添加x-codegen-ignore字段并设为true，多数主流OpenAPI代码生成器（如OpenAPI Generator）支持该扩展：

"parameters": [
  {
    "name": "Test-Token",
    "in": "header",
    "required": false,
    "schema": {
      "type": "string",
      "default": "test"
    },
    "x-codegen-ignore": true
  }
]

方案2：全局排除指定头部参数 #

如果需要批量排除该参数，可在生成客户端时通过全局配置参数实现：

• 命令行方式（OpenAPI Generator）：

  openapi-generator generate -i 你的API配置文件.json -g 目标语言（如java/python） --global-property skipHeaderParameters=Test-Token
  

• Maven插件方式：
  在插件配置中添加全局属性：

  <configuration>
    <inputSpec>你的API配置文件.json</inputSpec>
    <generatorName>java</generatorName>
    <globalProperties>
      <skipHeaderParameters>Test-Token</skipHeaderParameters>
    </globalProperties>
  </configuration>
  

注意事项 #

• 若你使用的是Swagger Codegen而非OpenAPI Generator，可尝试替换为x-swagger-codegen-ignore: true字段。
• 确保使用的生成器版本是较新的，部分旧版本可能对扩展字段支持不完善。

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