如何为FastAPI中所有APIRouter统一设置自定义route_class？

一、全局统一设置自定义route_class的方法 #

FastAPI官方没有提供直接全局配置所有APIRouter的route_class的API，但可以通过自定义基础路由类的方式实现统一配置，无需逐个传入参数：

1. 自定义BaseRouter继承FastAPI的APIRouter
   创建一个自己的APIRouter基类，在初始化时默认传入你的自定义route_class，之后所有业务路由都使用这个基类创建实例：

   from fastapi import APIRouter as FastAPIRouter
   
   # 你的自定义路由类（示例实现）
   class CustomRoute:
       def __init__(self, path: str, endpoint: callable):
           self.path = path
           self.endpoint = endpoint
           # 这里添加你的自定义逻辑，比如路由匹配规则、额外预处理等
   
   class APIRouter(FastAPIRouter):
       def __init__(self, *args, **kwargs):
           # 默认传入自定义route_class，也可保留参数让特殊路由按需覆盖
           super().__init__(route_class=CustomRoute, *args, **kwargs)
   

   之后在各个业务路由文件中，直接导入这个自定义的APIRouter创建实例即可：

   # 业务路由示例文件
   from .base_router import APIRouter
   
   router = APIRouter(prefix="/users")
   
   @router.get("/")
   def get_users():
       return {"message": "List of users"}
   

2. 可选：猴子补丁全局替换（不推荐）
   若不想修改现有路由的导入逻辑，可通过猴子补丁替换FastAPI默认APIRouter的初始化逻辑，但这种方式不够优雅，易引发未知问题，不建议生产环境使用：

   from fastapi import APIRouter
   from your_module import CustomRoute
   
   original_init = APIRouter.__init__
   
   def patched_init(self, *args, **kwargs):
       # 若未显式传入route_class，则使用自定义类
       kwargs.setdefault("route_class", CustomRoute)
       original_init(self, *args, **kwargs)
   
   APIRouter.__init__ = patched_init
   

   注意：此代码需在所有APIRouter实例创建前执行。

二、为什么include_router中设置route_class无效？ #

核心原因是：route_class是APIRouter实例的固有属性，在创建APIRouter对象时就已确定，include_router没有权限修改它。

FastAPI的include_router()函数仅负责将已初始化的APIRouter实例中的路由添加到主应用中，它的参数列表里并不包含route_class——你尝试传入的该参数会被直接忽略，因为函数根本不接收这个参数。只有在创建APIRouter实例时传入的route_class才会生效，这就是你在定义APIRouter的文件中设置有效、在include_router时设置无效的本质原因。

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