FastAPI-CRUDRouter 路由配置完全指南

原创于 2025-06-29 09:20:49 发布 · 658 阅读

12 ·

CC 4.0 BY-SA版权

FastAPI-CRUDRouter 路由配置完全指南

FastAPI-CRUDRouter 是一个强大的工具，能够自动为你的模型生成完整的CRUD路由。本文将深入解析其路由生成机制，帮助你掌握路由定制技巧。

默认路由生成机制

FastAPI-CRUDRouter 默认会为每个模型生成6个标准RESTful路由：

| 路由路径 | HTTP方法 | 功能描述 | |----------------|----------|--------------------------| | / | GET | 获取所有资源 | | / | POST | 创建新资源 | | / | DELETE | 删除所有资源 | | /{item_id} | GET | 获取指定ID的资源 | | /{item_id} | PUT | 更新指定ID的资源 | | /{item_id} | DELETE | 删除指定ID的资源 |

这些路由路径会自动添加前缀，前缀值取决于你使用的CRUDRouter类型和模型定义。

路由前缀配置技巧

路由前缀是自动生成的，但你可以完全控制它：

自动前缀生成规则
- MemoryCRUDRouter：使用Pydantic模型的类名作为前缀（小写形式）
- SQLAlchemyCRUDRouter：使用数据库表名作为前缀
自定义前缀 你可以通过prefix参数显式指定前缀：
```
router = CRUDRouter(model=MyModel, prefix='custom-prefix')
```

路由禁用与启用

FastAPI-CRUDRouter 提供了精细的路由控制能力，你可以选择性地禁用不需要的路由：

| 参数名 | 默认值 | 功能说明 | |-------------------|--------|----------------------------| | get_all_route | True | 是否生成获取所有资源的路由 | | get_one_route | True | 是否生成获取单个资源的路由 | | delete_all_route | True | 是否生成删除所有资源的路由 | | delete_one_route | True | 是否生成删除单个资源的路由 | | create_route | True | 是否生成创建资源的路由 | | update_route | True | 是否生成更新资源的路由 |

使用示例：

router = MemoryCRUDRouter(
    schema=MyModel,
    delete_all_route=False,  # 禁用删除所有资源的路由
    create_route=True       # 显式启用创建资源的路由
)

高级路由定制

当默认生成的路由不能满足需求时，你可以完全覆盖它们：

1. 路由覆盖方法

FastAPI-CRUDRouter 继承自FastAPI的APIRouter，因此支持所有标准路由装饰器：

@router.get()
@router.post()
@router.put()
@router.delete()
@router.api_route()

2. 路由覆盖示例

下面是一个覆盖默认路由的完整示例：

from pydantic import BaseModel
from fastapi import FastAPI
from fastapi_crudrouter import MemoryCRUDRouter as CRUDRouter

class Product(BaseModel):
    id: int
    name: str
    price: float

app = FastAPI()
router = CRUDRouter(schema=Product)

# 覆盖获取所有产品的路由
@router.get('')
async def custom_get_all():
    return {"message": "这是自定义的获取所有产品路由"}

# 覆盖获取单个产品的路由
@router.get('/{item_id}')
async def custom_get_one(item_id: int):
    return {"message": f"这是自定义的获取ID为{item_id}的产品路由"}

app.include_router(router)