FastAPI

Question

在FastAPI我有类似的情况：

models.py

class MachineGroups(Base):
    __tablename__ = 'MachineGroups'

    MachineGroupsId = Column(NVARCHAR(25), primary_key=True)
    Description = Column(NVARCHAR(255))


class Machines(Base):
    __tablename__ = 'Machines'

    MachinesId = Column(NVARCHAR(50), primary_key=True)
    Description = Column(NVARCHAR(255))
    MachineGroupsId = Column(NVARCHAR(25), ForeignKey("MachineGroups.MachineGroupsId", ondelete="SET NULL"), nullable=True)

    group = relationship("MachineGroups")

schemas.py

class MachineGroups(BaseModel):
    MachineGroupsId: str
    Description: str

    class Config:
        orm_mode = True


class Machines(BaseModel):
    MachinesId: str
    Description: str
    MachineGroupsId: str = None
    group: Optional[MachineGroups] = None

    class Config:
        orm_mode = True

在控制器中，我有一个这样创建的函数：

controller.py

@app.get(
    "/machines",
    response_model=List[machine_schemas.Machines],
    response_model_exclude={'group'}
)
def get_machines(db: Session = Depends(get_db)):
    return db.query(machine_models.Machines).all()

我希望能够直接从 API 调用中设置装饰器中的 response_model_exclude 字段值。在实践中，我希望函数有一个查询参数，允许我获取或不获取外键信息。

为了避免出现这种情况：

@app.get(
    "/machines",
    response_model=List[machine_schemas.Machines],
    response_model_exclude={'group'}
)
def get_machines(db: Session = Depends(get_db)):
    return db.query(machine_models.Machines).all()

@app.get(
    "/machines/all",
    response_model=List[machine_schemas.Machines],
)
def get_machines_all(db: Session = Depends(get_db)):
    return db.query(machine_models.Machines).all()

有可能实现吗？

谢谢。

Answer 1

我通过创建自定义 JSONResponse 并使用 jsonable_encoder 函数排除外键字段解决了这个问题。

@app.get(
    "/machines/all",
    response_model=List[machine_schemas.Machines],
)
def get_machines_all(get_foreign_keys: bool = True, db: Session = Depends(get_db)):
    machines = db.query(machine_models.Machines).all()
    if get_foreign_keys:
        return machines
    else:
        return JSONResponse(jsonable_encoder(machines, exclude={'group'}))

FastAPI - 在调用 API 时设置 response_model_exclude

FastAPI - Set response_model_exclude when calling API

python-3.x