重复检查FastAPI中ID路径参数

Question

我有以下路线规格：

GET    /councils/{id}
PUT    /councils/{id}
DELETE /councils/{id}

在所有三个路线中，我必须在数据库中检查是否存在id的理事会，例如：

council = crud.council.get_by_id(db=db, id=id)
    if not council:
        raise HTTPException(
            status_code=status.HTTP_404_NOT_FOUND,
            detail='Council not found'
        )

这增加了代码中的许多样板。有什么方法可以减少这一点吗？我已经想到了创建依赖性，但是随后我必须为数据库中的不同模型编写不同的依赖性功能。有什么标准做法吗？ 谢谢。

Answer 1

使用依赖性是要走的方法 - 它允许您提取围绕“从URL获得有效理事会”的逻辑；如果要映射/＆lt;/＆gt;/＆lt; id＆gt;始终从特定模型中检索某些内容，则可以进一步概括它；但是 - 您可能需要根据一组可能的值对此进行验证，以避免人们试图在模型类中加载随机的Python标识符。

from fastapi import Path

def get_council_from_path(council_id: int = Path(...),
                          db: Session = Depends(get_db),
):
  council = crud.council.get_by_id(db=db, id=id)

  if not council:
    raise HTTPException(
      status_code=status.HTTP_404_NOT_FOUND,
      detail='Council not found'
    )

  return council


@app.get('/councils/{council_id}')
def get_council(council: Council = Depends(get_council_from_path)):
  pass

您可以概括依赖关系定义以使其可重复使用（我现在没有任何可用的测试，但是这个想法应该起作用）：

def get_model_from_path(model, db: Session = Depends(get_db)):
  def get_model_from_id(id: int = Path(...)):
    obj = model.get_by_id(db=db, id=id)

    if not council:
      raise HTTPException(
        status_code=status.HTTP_404_NOT_FOUND,
        detail='{type(model)} not found'
      )

  return get_model_from_id


@app.get('/councils/{id}')
def get_council(council: Council = Depends(get_model_from_path(crud.council)):
  pass

Answer 2

这是一种有效的解决方案。 FastApi支持类作为依赖项。因此，我可以拥有这样的类：

class DbObjIdValidator:
    def __init__(self, name: str):
        if name not in dir(crud):
            raise ValueError('Invalid model name specified')
        
        self.crud = getattr(crud, name)

    def __call__(self, db: Session = Depends(get_db), *, id: Any):
        db_obj =  self.crud.get_by_id(db=db, id=id)
        if not db_obj:
            raise HTTPException(
                status_code=status.HTTP_404_NOT_FOUND,
                detail='not found'
            )
        
        return db_obj

考虑crud模块将为所有ORM模型导入CRUD类。我的示例紧随 fastapapi cookiecutter项目他遵循的模式。

现在，为了使用它，例如在consems_route.py中，我可以做以下操作：

router = APIRouter(prefix='/councils')

council_id_dep = DbObjIdValidator('council') # name must be same as import name

@router.get('/{id}', response_model=schemas.CouncilDB)
def get_council_by_id(
    id: UUID, 
    db: Session = Depends(get_db),
    council: Councils = Depends(council_id_dep)    
):

    return council