✨ Add support for Pydantic models for parameters using `Query`, `Cookie`, `Header` by tiangolo · Pull Request #12199 · fastapi/fastapi

tiangolo · 2024-09-13T20:38:49Z

✨ Add support for Pydantic models for parameters using Query, Cookie, Header

…meter models

… docs

…rix of variations)

github-actions · 2024-09-13T20:45:02Z

📝 Docs preview for commit 7e373ff at: https://8d8a71b9.fastapitiangolo.pages.dev

Modified Pages

Co-authored-by: Nico Tonnhofer <[email protected]>

github-actions · 2024-09-16T18:18:32Z

📝 Docs preview for commit ece2dbc at: https://448500ab.fastapitiangolo.pages.dev

Modified Pages

tonnico

I'm looking forward for this PR. This will makes some parts much more simple.

Thanks in advance 🤗

github-actions · 2024-09-17T18:43:11Z

📝 Docs preview for commit 28957e3 at: https://0a46561b.fastapitiangolo.pages.dev

Modified Pages

github-actions · 2024-09-17T18:46:51Z

📝 Docs preview for commit dbe50fd at: https://a5f88e6a.fastapitiangolo.pages.dev

Modified Pages

oogetyboogety · 2024-09-26T22:40:56Z

@tiangolo is there a way we can work together on extending support for
a) https://fastapi.tiangolo.com/tutorial/header-params/#automatic-conversion for CommonHeaders, docs show the underscores still remain underscores:

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] = []

I realized you were saying that the usability of this functionality in Depends works, but coincidentally works.
I would still like for automatic conversion to happen on these Pydantic parameters models though, even if included via Depends.
We have noticed some odd behavior (input parameter becomes a json object) when trying to use Depends and Header model together. It works as expected by only including "repeated" header parameter in Depends. Perhaps we could add tests for these repeated parameters when they are also in Pydantic model.

…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.

ollie-bell · 2024-10-24T22:22:35Z

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 other_param: str = "foo" (and forbidding extra parameters in the model doesn't fix it).

GET http://127.0.0.1:8000/items/
{"detail":[{"type":"missing","loc":["query","filter_query"],"msg":"Field required","input":null}]}

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

…ie`, `Header` (fastapi#12199)

…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.

…g Query, Cookie and Header 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.

tiangolo added 28 commits September 12, 2024 19:06

✨ Add support for Pydantic models for Query, Header, and Cookie params

116bb1f

📝 Add source examples for matrix of versions, for docs for query para…

2f81cf4

…meter models

✅ Add tests for query param models

33255f1

🔨 Add Playwright script to generate screenshot for Query Param Models…

2571ca6

… docs

🍱 Add screenshot for Query Param Models docs

723fd62

📝 Add docs for Query Param Models

919ffcb

🔧 Add new docs for Query Param Model docs to MkDocs

48813ab

✅ Update tests with compatibility for Pydantic v1

c1cd09e

🐛 Fix OpenAPI generation with compatibility with Pydantic v1

8073a32

📝 Add source examples for docs for Cookie params with models (and mat…

6317cb0

…rix of variations)

✅ Add tests for cookies with models

a666dd9

📝 Add Pydantic v1 versions for tests

aef9ddb

📝 Add tip in Query models about Cookie and Header models

277f650

📝 Add docs for Cookie param models

f8431c2

🐛 Fix check for query params for Pydantic v1

9867dd4

🔨 Add screenshot script for Cookie param models

bc6fb56

✅ Add tests for Cookie param models

489038f

🍱 Add screenshot for Cookie param models

1e004b0

📝 Add docs for header parameter models

238ce74

📝 Add source examples for header param models

b6a8c05

✏️ Tweak punctuation

5e27bbf

🍱 Add screenshot for docs for header param models

03703ee

✅ Add tests for header param models

d976eb2

🐛 Fix support for header models with convert_underscores

f3d0f77

🔨 Add script to generate screenshot for header param models

169bd35

🔧 Add new docs to MkDocs

35f7170

✅ Add tests version for Pydantic v1

c5c0451

Merge branch 'master' into query-models

7e373ff

tiangolo added the feature New feature or request label Sep 13, 2024

tonnico reviewed Sep 16, 2024

View reviewed changes

Comment thread docs/en/docs/tutorial/cookie-param-models.md Outdated

✏️ Fix typo in docs/en/docs/tutorial/cookie-param-models.md

ece2dbc

Co-authored-by: Nico Tonnhofer <[email protected]>

tonnico reviewed Sep 16, 2024

View reviewed changes

Comment thread docs_src/query_param_models/tutorial001.py

Comment thread docs_src/query_param_models/tutorial001.py

tiangolo added 2 commits September 17, 2024 20:34

📝 Update docs for query, header, cookie param models

4f9de3d

✅ Update tests

28957e3

Merge branch 'master' into query-models

dbe50fd

tiangolo marked this pull request as ready for review September 17, 2024 18:53

tiangolo merged commit 55035f4 into master Sep 17, 2024

tiangolo deleted the query-models branch September 17, 2024 18:54

tiangolo mentioned this pull request Sep 18, 2024

Validation of pydantic models in query params #11243

Closed

JSCU-CNI mentioned this pull request Oct 17, 2024

✨ Support for mixed and multiple Pydantic models for parameters using Query, Cookie and Header #12481

Open

s-rigaud pushed a commit to s-rigaud/fastapi that referenced this pull request Jan 23, 2025

✨ Add support for Pydantic models for parameters using Query, `Cook…

d1215ff

…ie`, `Header` (fastapi#12199)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

✨ Add support for Pydantic models for parameters using `Query`, `Cookie`, `Header`#12199

✨ Add support for Pydantic models for parameters using `Query`, `Cookie`, `Header`#12199
tiangolo merged 32 commits intomasterfrom
query-models

tiangolo commented Sep 13, 2024

Uh oh!

github-actions Bot commented Sep 13, 2024

Uh oh!

Uh oh!

github-actions Bot commented Sep 16, 2024

Uh oh!

tonnico left a comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2024

Uh oh!

github-actions Bot commented Sep 17, 2024

Uh oh!

oogetyboogety commented Sep 26, 2024 •

edited

Loading

Uh oh!

ollie-bell commented Oct 24, 2024 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Uh oh!

Conversation

tiangolo commented Sep 13, 2024

Uh oh!

github-actions Bot commented Sep 13, 2024

Modified Pages

Uh oh!

Uh oh!

github-actions Bot commented Sep 16, 2024

Modified Pages

Uh oh!

tonnico left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Sep 17, 2024

Modified Pages

Uh oh!

github-actions Bot commented Sep 17, 2024

Modified Pages

Uh oh!

oogetyboogety commented Sep 26, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ollie-bell commented Oct 24, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

oogetyboogety commented Sep 26, 2024 •

edited

Loading

ollie-bell commented Oct 24, 2024 •

edited

Loading