从 sqlmodel 获取连接表作为 fastapi 中的嵌套响应模型

我无法弄清楚如何使用 fastapi 和 sqlmodel 显示一对多关系。我读过这篇文章question https://stackoverflow.com/questions/72870598/getting-nested-joined-tables-to-display-in-the-openapi-interface-provided-by-f/73372947?noredirect=1#comment131875135_73372947但我的情况似乎略有不同。特别是在函数调用中。

这是我的schemas.py:

from typing import Optional
from sqlmodel import Field, Relationship, SQLModel

class BinaryBase(SQLModel):
    product_id: int
    software_install_path: Optional[str] = None
    host_id: int = Field(foreign_key="host.id", nullable=False)


class Binary(BinaryBase, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    host_id: int = Field(foreign_key="host.id", nullable=False)
    host: "Host" = Relationship(back_populates="binaries")


class HostBase(SQLModel):
    name: str
    region: Optional[str] = None
    os_version: Optional[str] = None
    network: Optional[int] = None


class Host(HostBase, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    binaries: list[Binary] = Relationship(back_populates='host')


class HostReadWithBinary(HostBase):
    bins: list[HostBase] = []


class BinaryReadWithHost(BinaryBase):
    host: BinaryBase

这是我的main.py:

from fastapi import Depends, FastAPI
from sqlmodel import Session, col, select

...

@app.get(
    "/binaries/",
    response_model=list[HostReadWithBinary]
)
def get_binary(name: Optional[str] = None, session: Session = Depends(get_session)) -> list[HostReadWithBinary]:
    query = select(Host).limit(100)
    if name:
        query = query.where(col(Host.name).contains(name.lower()))

    return session.exec(query).all()

The Host表代表1部分和Binary表代表many部分。我想得到所有的回应BinaryBase热切地为所有主机提供属性。但我得到的是这样的：

[
  {
    "name": "hkl20014889",
    "region": "HK",
    "os_version": "Red Hat 6.10",
    "network": 3,
    "bins": []
  },
  {
    "name": "hkl20016283",
    "region": "HK",
    "os_version": "Red Hat 6.10",
    "network": 3,
    "bins": []
  },
.... 

理论上bins应该持有的属性Host表当id in Host joins host_id在二进制中。

你需要意识到，当你定义一个response_model对于路线，它总是尝试解析来自路线处理函数的任何数据（get_binary在本例中）通过该模型。这基本上是通过调用来完成的.from_orm https://docs.pydantic.dev/usage/models/#orm-mode-aka-arbitrary-class-instances响应模型上的方法，它遍历其上定义的所有字段并尝试查找相应的您传递给它的对象的属性（即具有相同的名称）。

您指定的模型（在列表中，但参数成立）是HostReadWithBinary。除了在其父模型上定义的字段之外HostBase它只有字段bins，这应该是一个列表HostBase.

首先我觉得你meant声明bins字段的类型为list[BinaryBase], not list[HostBase]。如果您正确命名了该字段，这会导致错误，但这就是您的第二个错误出现的地方。

您还在响应模型中命名了该字段bins，但是您的处理程序函数执行一个返回列表的查询Host模型实例。那个型号不具有 a bins场地。它有一个名为binaries。这意味着当from_orm方法到达HostReadWithBinary.bins字段，它检查是否对应Host实例有一个名为bins。它没有找到，但没问题，因为你设置了默认值HostReadWithBinary.bins，即空列表[]，这就是每个生成的响应模型实例上设置的内容。

因此，您应该能够通过更改响应模型定义来修复错误，如下所示：

class HostReadWithBinary(HostBase):
    binaries: list[BinaryBase] = []

或者，您可以更改您的关系字段的名称Host model:

class Host(HostBase, table=True):
    id: Optional[int] = Field(default=None, primary_key=True)
    bins: list[Binary] = Relationship(back_populates='host')


class HostReadWithBinary(HostBase):
    bins: list[BinaryBase] = []

它们必须相同，否则将一种模型的对象解析为另一种模型将无法（正确）工作。

旁注：您还错误地注释了host场上BinaryReadWithHost with BinaryBase代替HostBase.

PS：我还刚刚注意到一个与类型注释相关的小错误。您将路由处理函数的返回类型声明为list[HostReadWithBinary]，但这不是它返回的内容。它返回list[Host]。这是对响应模型的误解的一部分。这装饰的返回的是您的路线版本list[HostReadWithBinary]。您的路线处理程序get_binary本身（即装饰之前）返回list[Host]，即then传递给它周围的包装器，该包装器将其解析为list[HostReadWithBinary]并按其方式发送该数据（最终发送给客户端）。这个包装器操作显然发生在幕后，并且是 FastAPI 装饰器魔法的一部分。