使用 Pydantic model 的 FastAPI 查询参数

Question

我有一个 Pydantic model 如下

class Student(BaseModel):
    name:str
    age:int

通过这个设置，我希望得到如下的 OpenAPI 模式，

那么，如何使用 Pydantic model 在 FastAPI 中获取 from 查询参数？

Answer 1

你可以做这样的事情，

from fastapi import FastAPI, Depends

from pydantic import BaseModel

app = FastAPI()


class Student(BaseModel):
    name: str
    age: int


@app.get("/")
def read_root(student: Student = Depends()):
    return {"name": student.name, "age": student.age}

另外，请注意查询参数通常是“可选”字段，如果您希望将它们设为可选，请使用Optional类型提示，

from fastapi import FastAPI, Depends
from typing import Optional
from pydantic import BaseModel

app = FastAPI()


class Student(BaseModel):
    name: str
    age: Optional[int]


@app.get("/")
def read_root(student: Student = Depends()):
    return {"name": student.name, "age": student.age}