如何在OpenAPI生成的FastAPI项目中实现并生效自定义逻辑？

问题背景 #

使用OpenAPI Generator生成的FastAPI项目，需要在impl/media_files_api.py中实现自定义API逻辑，但启动服务器后自定义逻辑未生效，调用端点返回null而非预期结果。项目结构如下：

media_api_python/
└── openapi_server/
    ├── apis/
    │   ├── __init__.py
    │   ├── media_files_api.py
    │   └── media_files_api_base.py
    ├── impl/
    │   ├── __init__.py
    │   └── media_files_api.py
    ├── main.py
    └── models/
        ├── __init__.py
        ├── appearance.py
        ├── bounding_box.py
        ...

解决方案 #

1. 确保自定义逻辑被调用的核心修改 #

问题出在apis/media_files_api.py的路由处理函数未关联impl中的实现类。需要修改该文件的路由函数，使其主动调用impl中继承自BaseMediaFilesApi的子类方法：

修改apis/media_files_api.py的media_files_mediafile_post函数：

from fastapi import APIRouter, Form
from starlette.concurrency import run_in_threadpool
from openapi_server.apis.media_files_api_base import BaseMediaFilesApi
import pkgutil
import importlib
import openapi_server.impl

router = APIRouter()

ns_pkg = openapi_server.impl
for _, name, _ in pkgutil.iter_modules(ns_pkg.__path__, ns_pkg.__name__ + "."):
    importlib.import_module(name)

@router.post("/MediaFiles/mediafile", response_model=object, summary="Upload media file")
async def media_files_mediafile_post(file: str = Form(None, description="")) -> object:
    # 获取已注册的实现类（BaseMediaFilesApi会自动收集子类）
    if not BaseMediaFilesApi.subclasses:
        raise RuntimeError("No implementation found for MediaFilesApi")
    # 实例化实现类
    api_impl = BaseMediaFilesApi.subclasses[0]()
    # 同步方法转为异步执行，避免阻塞FastAPI事件循环
    result = await run_in_threadpool(api_impl.media_files_mediafile_post, file)
    return result

2. "Hello World"自定义实现示例 #

在impl/media_files_api.py中编写如下实现：

from openapi_server.apis.media_files_api_base import BaseMediaFilesApi

class MediaFilesApiImpl(BaseMediaFilesApi):
    def media_files_mediafile_post(self, file: str):
        # 自定义逻辑：返回包含文件名的Hello World信息
        return {"Hello": f"World: {file.split('/')[-1] if '/' in file else file}"}

验证方法 #

启动服务器：

uvicorn openapi_server.main:app --host 0.0.0.0 --port 8080

执行curl测试：

curl -X POST "http://localhost:8080/MediaFiles/mediafile" -H "Content-Type: application/x-www-form-urlencoded" --data-urlencode "file=setup.cfg"

预期返回：

{"Hello": "World: setup.cfg"}

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