如果使用响应模型，如何将附加信息(如查询)插入到响应中？

Question

我现在正在尝试使用FastAPI构建一个API。我想让一个路由（接受查询）也在响应中返回它们，以便用户可以仔细检查他输入的查询（也可以查看总共有多少页等）。

我正在使用response_model响应方式，并且一生都无法弄清楚如何将其他参数插入响应中。

我已经尝试将响应模型中的所有字段设置为可选，因此它在检查时不再抛出错误，但它仍然只是（如果它响应）在没有添加信息的情况下响应。在下面，您可以看到我用于response_model的路由和架构。

这是我想应用这个的路线。

@router.get("/", response_model=List[schemas.StockResponse], tags=["Stocks"])
def get_stocks(response= Response, db: Session = Depends(get_db), current_user: int = Depends(oauth2.get_current_user), limit: int = 100, skip: int = 0):
    utils.increase_request_counter(current_user, db)
    stocks = db.query(models.Stock).limit(limit).offset(skip).all()
    return stocks

我想要的是，它返回股票列表，但也返回有关上述查询参数的信息。例如：

[{"params": {
           "limit" : 10,
           "skip": 0 },
 {"data": [ *then list of dictionaries that it already returns*]}]

类似这样的东西，但我不能让它返回任何东西，除了字典列表。

这是该模型正在使用的模式（斯托克响应）

class StockBase(BaseModel):
    name: str
    ticker: str
    price: float
    dividends: float
    dividend_yield: float
    ftweek_low: Optional[float] = Body(None)
    ftweek_high: Optional[float] = Body(None)
    trading_market: Optional[str] = Body(None)
    market_cap: Optional[int] = Body(None)
    payout_ratio: Optional[float] = Body(None)
    beta: Optional[float] = Body(None)
    business_summary: Optional[str] = Body(None)
    website: Optional[str] = Body(None)
    logo: Optional[str] = Body(None)
    time_updated: Optional[datetime] = Body(datetime.now())
    sector: Optional[str] = Body(None)
    industry: Optional[str] = Body(None)
    
class StockResponse(StockBase):
    ID: Optional[int]
    name: Optional[str]
    ticker: Optional[str]
    price: Optional[float]
    dividends: Optional[float]
    dividend_yield: Optional[float]
    time_created: Optional[datetime]
        
    class Config:
         orm_mode = True    

Answer 1

创建一个与您要返回的内容匹配的响应模型，并相应地填充它：

from pydantic import BaseModel


class StockRequestParams(BaseModel):
  limit: int
  skip: int


class StockResponseWithMetadata(BaseModel):
  params: StockRequestParams
  stocks: List[StockResponse]


def get_stocks(...):
  ...
  return StockResponseWithMetadata(
    params=StockRequestParams(hits=hits, limit=limit), 
    stocks=socks,
  )