如何使用openapi-generator-cli生成Python封装时为指定查询参数自定义序列化逻辑？

我完全懂你的痛点——每次生成代码后手动改序列化逻辑太麻烦，万一重新生成又得重来，太折腾了。下面给你几个能在代码生成阶段就搞定的方案，都是一劳永逸的：

方案1：调整OpenAPI规范文件（最推荐） #

其实你的需求刚好契合OpenAPI v3本身对数组参数的序列化支持，只要修改规范里的参数定义，openapi-generator会自动生成符合你要求的代码，完全不用额外配置。

把原来的字符串类型参数改成数组类型，同时指定序列化样式为form且不展开（explode: false），这样生成器会自动把数组转成逗号分隔的字符串。修改后的规范如下：

paths:
  /content:
    get:
      description: Returns data for all given ids
      parameters:
      - description: Comma-separated list of ids
        in: query
        name: ids
        required: true
        schema:
          type: array
          items:
            type: string
        style: form
        explode: false

为什么这样有效？ #

• style: form 指定数组参数用表单风格序列化
• explode: false 告诉生成器把数组元素合并成单个逗号分隔的字符串，而不是生成多个?ids=xxx&ids=yyy的参数

这样生成的Python代码里，content_get的ids参数会自动变成Annotated[Iterable[StrictStr]]，序列化函数也会自动处理成','.join(ids)的逻辑，完全符合你的需求。

方案2：自定义代码生成模板（适合无法修改原规范的场景） #

如果因为某些原因不能修改原OpenAPI规范，那可以通过自定义openapi-generator的Python模板来实现。

步骤： #

1. 先导出Python生成器的默认模板：

openapi-generator-cli template export -g python -o ./custom-python-templates

2. 找到并修改模板文件：
   • 打开./custom-python-templates/serializer.mustache（序列化逻辑的模板），找到处理查询参数的代码段，添加对ids参数的特殊处理：

     {% if paramName == 'ids' %}
         _query_params.append(('ids', ','.join(ids)))
     {% else %}
         _query_params.append(('{{paramName}}', {{paramName}}))
     {% endif %}
     

   • 再打开./custom-python-templates/api.mustache（API函数定义的模板），把ids参数的类型从StrictStr改成Iterable[StrictStr]，记得要提前在模板的导入部分添加from typing import Iterable。
3. 用自定义模板生成代码：

openapi-generator-cli generate -i your-openapi.yaml -g python -o ./generated-code -t ./custom-python-templates

这样生成的代码就会自动接受可迭代的字符串集合，并在序列化时转成逗号分隔的字符串。

方案3：自定义生成器插件（适合复杂自定义场景） #

如果你的项目有很多类似的自定义需求，可以写一个openapi-generator的Python插件来扩展生成逻辑，但这个方案相对复杂，需要了解生成器的插件机制，一般前两个方案足够解决你的问题了。

备注：内容来源于stack exchange，提问作者Charles