返回带有字段名称而不是别名的 pydantic 模型作为 fastapi 响应

Question

我正在尝试使用定义的字段名称而不是别名返回我的模型。

class FooModel(BaseModel):
    foo: str = Field(..., alias="bar")

@app.get("/") -> FooModel:
    return FooModel(**{"bar": "baz"})

响应将是{"bar": "baz"}而我想要{"foo": "baz"} 。 我知道在使用模型的dict方法时有点可能，但是感觉不对并且弄乱了请求处理程序的输入。

@app.get("/") -> FooModel:
    return FooModel(**{"bar": "baz"}).dict(by_alias=False)

我觉得应该可以在config class 中设置它，但我找不到正确的选项。

Answer 1

您可以将response_model_by_alias=False添加到路径操作装饰器。 此处在文档中提到了此密钥。

例如：

@app.get("/model", response_model=Model, response_model_by_alias=False)
def read_model():
    return Model(alias="Foo")