使用 Pydantic model 的 FastAPI 查询参数

Question

I have a Pydantic model as below

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

With this setup, I wish to get the OpenAPI schema as following,

So, how can I use the Pydantic model to get the from query parameter in FastAPI?

Answer 1

You can do something like this,

from fastapi import FastAPI, 

from pydantic import BaseModel

app = FastAPI()


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


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

Also, note that the query parameters are usually " optional " fields and if you wish to make them optional, use Optional type hint as,

from fastapi import FastAPI, Depends

from pydantic import BaseModel

app = FastAPI()


class Student(BaseModel):
    name: str
    age: 


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