如何在Swagger生成的Flask代码中添加自定义功能？

你遇到的问题其实很常见，针对不同的使用场景，有几种不同的解决方案，我给你拆解清楚：

方案1：直接修改生成后的控制器（最快上手，适合一次性生成） #

这是最直接的方式，完全不需要折腾模板或者脚本，适合你只需要生成一次代码的场景：

1. 打开生成的mycode/controllers/developers_controller.py文件
2. 找到你要修改的GET方法（比如def get_developers():，具体名称取决于你Swagger YAML里的operationId）
3. 把默认的return "do some magic!", 200这段代码，替换成你的数据库查询逻辑。举个例子：

from flask import jsonify
# 导入你自己的数据库操作模块，比如SQLAlchemy的模型或自定义的DB工具
import my_project.db_utils

def get_developers():
    # 从数据库拉取数据的逻辑
    developers = my_project.db_utils.fetch_all_developers()
    # 转换成JSON格式返回
    return jsonify(developers), 200

这种方式的好处是零学习成本，改完就能用；但如果后续你需要重新生成代码（比如Swagger YAML更新了），这次的修改会被覆盖，需要重新改一遍。

方案2：定制Swagger Codegen模板（适合重复生成，长期维护） #

如果需要多次生成代码，不想每次手动修改控制器，那定制模板是最优解。别担心，完全不需要懂Java，只需要简单修改Mustache模板文件就行：

1. 获取官方模板文件：你可以从Swagger Codegen的Python-Flask模板里找到controller.mustache（这是生成控制器代码的核心模板）。或者用命令查看模板相关信息：

   java -jar swagger-codegen-cli.jar config-help -l python-flask
   

2. 创建本地模板目录：在本地新建一个文件夹，比如./custom-templates/python-flask，把下载的controller.mustache复制到这个目录里。
3. 修改模板内容：打开controller.mustache，找到生成默认返回值的那段代码，替换成你需要的数据库逻辑框架。比如把：

   return "do some magic!", 200
   

   改成：

   from flask import jsonify
   import my_project.db_utils
   
   data = my_project.db_utils.{{operationId.replace("get_", "fetch_")}}()
   return jsonify(data), 200
   

   这里的{{operationId}}是Swagger YAML里定义的操作ID，会被自动替换成实际的方法名，比如get_developers会变成fetch_developers（如果用了上面的replace逻辑）。
4. 用自定义模板重新生成代码：生成时加上-t参数指定模板目录：

   java -jar swagger-codegen-cli.jar generate -l python-flask -i swagger.yaml -o mycode/ -t ./custom-templates/python-flask/
   

   这样每次生成的控制器都会自带你的数据库逻辑框架，不用再手动修改了。

方案3：用脚本自动修改生成后的文件（适合自动化场景） #

如果你不想碰模板，又想自动化完成修改，可以用sed或者awk这类工具写个简单脚本。比如写一个shell脚本post-gen.sh：

#!/bin/bash
# 替换developers_controller.py里的默认返回
sed -i 's/return "do some magic!", 200/from flask import jsonify\nimport my_project.db_utils\n    developers = my_project.db_utils.fetch_all_developers()\n    return jsonify(developers), 200/' mycode/controllers/developers_controller.py

每次生成代码后，运行这个脚本就能自动完成替换。这种方式的好处是不用改模板，但缺点是如果Swagger Codegen更新了生成代码的结构，你的sed命令可能会失效，需要调整。

最后澄清几个你的疑惑： #

• 完全不需要复制FlaskConnexionCodegen.java，也不需要懂Java，只需要修改Mustache模板文件就行
• 模板定制是长期维护的最佳方案，尤其是需要频繁更新Swagger YAML并重新生成代码的场景
• 如果只是一次性生成代码，直接修改控制器文件最省事

内容的提问来源于stack exchange，提问作者Michal 艩pondr