✨ Add support for Pydantic models for parameters using Query, Cookie, Header
#12199
Conversation
…rix of variations)
Co-authored-by: Nico Tonnhofer <github@wurstnase.de>
|
@tiangolo is there a way we can work together on extending support for class CommonHeaders(BaseModel):
model_config = {"extra": "forbid"}
host: str
save_data: bool
if_modified_since: str | None = None
traceparent: str | None = None
x_tag: list[str] = []
|
…der and cookie From fastapi#12199 onwards, Pydantic models are supported for query, cookie and header parameters. When one parameter is present, the model is flattened in the OpenAPI spec, but when multiple are defined, they aren't. This is confusing, and results in a confusing OpenAPI spec. Since these arguments are used in flattened form anyway, it makes more sense to flatten all of them.
|
Is it possible to mix "vanilla" query parameters with the new model parameters introduced in this PR? e.g. the example from the docs no longer works with an additional from typing import Annotated, Literal
from fastapi import FastAPI, Query
from pydantic import BaseModel, Field
app = FastAPI()
class FilterParams(BaseModel):
model_config = {"extra": "forbid"}
limit: int = Field(100, gt=0, le=100)
offset: int = Field(0, ge=0)
order_by: Literal["created_at", "updated_at"] = "created_at"
tags: list[str] = []
@app.get("/items/")
async def read_items(filter_query: Annotated[FilterParams, Query()], other_param: str = "foo"):
return filter_query |
✨ Add support for Pydantic models for parameters using
Query,Cookie,Header