✨ Allow to have multiple Query parameter models by uriyyo · Pull Request #12944 · fastapi/fastapi

uriyyo · 2024-11-16T11:41:33Z

Currently, it's allowed to have only one model as a query/headers/etc model parameter, in this PR I propose to remove this restriction. This PR should be backward-compatible.

For instance, example below will not work:

from typing import Annotated

from pydantic import BaseModel

from fastapi import FastAPI, Query

app = FastAPI()


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


class PageParams(BaseModel):
    limit: int
    offset: int


@app.get("/")
async def route(
    filters: Annotated[FilterParams, Query()],
    page: Annotated[PageParams, Query()],
):
    return {}

And same here:

from typing import Annotated

from pydantic import BaseModel

from fastapi import FastAPI, Query

app = FastAPI()


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


@app.get("/")
async def route(
    filters: Annotated[FilterParams, Query()],
    limit: Annotated[int, Query()],
    offset: Annotated[int, Query()],
):
    return {}

WIth this PR both examples above will work as expected. Also, it will generate the correct OpenAPI schema:

Discussion - #12212

wu-clan · 2024-11-17T05:57:21Z

This looks similar to #12481

uriyyo · 2024-11-17T09:56:36Z

I agree, It does solve the same issue. I didn't see it when I started working on this PR(

jperuggia · 2025-01-28T18:24:40Z

Hope this gets approved and released soon !

Ale-Cas · 2025-02-02T15:32:47Z

+    fields_to_extract = []
+    for f in fields:
+        if lenient_issubclass(f.type_, BaseModel):
+            fields_to_extract.extend(get_cached_model_fields(f.type_))
+        else:
+            fields_to_extract.append(f)
+    return fields_to_extract


I think that this could be simplified a little bit:

fields_to_extract = [get_cached_model_fields(f.type_) for f in fields if lenient_issubclass(f.type_, BaseModel)] fields.extend(fields_to_extract) return fields

I'm not sure it will work, because we will have both base model and all fields, we want to remove based model and keep only it fields.

Mulugruntz · 2025-03-05T09:17:05Z

This looks awesome! Really looking forward to it!
Do we know if/when it'll be approved and released?

Vaserty · 2025-03-15T12:02:38Z

Do we know when this will be published? It would make things easier.

uriyyo · 2025-08-05T09:38:10Z

Just merged with master and fixed tests, @Kludex any chance you can take a look on this PR? 🙏

bassemkaroui · 2025-08-12T22:19:03Z

@Ale-Cas can you please take a look at this ?

bobbyo · 2025-09-15T20:03:50Z

is this merging soon? would be nice to have pagination and query on models in FastAPI, which is blocked on merging this PR ....

bjmc · 2025-11-20T16:07:08Z

Just chiming in that my team are also interested in this feature. 🙏

bjmc · 2025-11-21T08:49:53Z

I've just noticed that the same limitation seems to affect Form(), could this fix be extended to cover form POST as well?

Copilot

Pull request overview

This PR enables FastAPI to support multiple Pydantic model parameters for Query, Header, and Cookie annotations. Previously, only a single model parameter was allowed per endpoint. The changes update the parameter flattening and validation logic to handle multiple models or a mix of model and scalar parameters.

Key changes:

Modified _get_flat_fields_from_params to iterate through all fields and extract model fields for each
Refactored request_params_to_args to process multiple BaseModel parameters by building a comprehensive parameter dictionary and validating each field appropriately
Added comprehensive test coverage for multiple models and mixed scenarios across Query, Header, and Cookie parameters

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.

File	Description
`fastapi/dependencies/utils.py`	Updated parameter processing logic to handle multiple Pydantic models in `_get_flat_fields_from_params` and `request_params_to_args` functions
`tests/test_multiple_params_models.py`	Added comprehensive tests validating multiple parameter models and mixed scenarios for Query, Header, and Cookie parameters, including OpenAPI schema verification

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

github-actions · 2025-12-12T15:00:54Z

This pull request has a merge conflict that needs to be resolved.

Co-authored-by: Copilot <[email protected]>

…rams-models

uriyyo · 2026-02-08T13:51:47Z

Hi @tiangolo,

Any chance you can take a look at this PR? 🙏

codspeed-hq · 2026-02-08T13:54:05Z

CodSpeed Performance Report

Merging this PR will not alter performance

_{Comparing uriyyo:multiple-query-params-models (ed24198) with master (376e108)¹}

Summary

✅ 20 untouched benchmarks

No successful run was found on master (cd31576) during the generation of this report, so 376e108 was used instead as the comparison base. There might be some changes unrelated to this pull request in this report. ↩

wu-clan · 2026-02-08T14:36:20Z

The maintenance team seems to be moving forward with #12481, but still have to wait for a response from tiangolo.

uriyyo and others added 2 commits November 16, 2024 12:35

Allow to have multiple Query parameter models

d8d097d

🎨 [pre-commit.ci] Auto format from pre-commit.com hooks

64f3cea

uriyyo mentioned this pull request Nov 16, 2024

Query parameter models work incorrectly if fastapi-pagination enabled (FastAPI >= 0.115.0) uriyyo/fastapi-pagination#1314

Open

Add tests

02a39f6

svlandeg added the feature New feature or request label Nov 25, 2024

svlandeg changed the title ~~Allow to have multiple Query parameter models~~ ✨ Allow to have multiple Query parameter models Nov 25, 2024

svlandeg and others added 3 commits November 25, 2024 11:20

Merge branch 'master' into multiple-query-params-models

2260de3

Merge branch 'master' into multiple-query-params-models

4e55a0c

Merge branch 'master' into multiple-query-params-models

506e629

Merge branch 'master' into multiple-query-params-models

edc1eac

Ale-Cas reviewed Feb 2, 2025

View reviewed changes

Comment thread fastapi/dependencies/utils.py Outdated

JSCU-CNI mentioned this pull request Jul 11, 2025

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

Open

YuriiMotov mentioned this pull request Jul 23, 2025

🐛 Fix extraction of BaseModel fields for openapi #13427

Closed

uriyyo added 3 commits August 5, 2025 11:06

Merge with origin/master

67d9605

Simplify fields to extract calculation

f647317

Fix header tests

66b486b

uriyyo requested a review from Ale-Cas August 5, 2025 09:31

Merge branch 'master' into multiple-query-params-models

0e3b611

uriyyo added 2 commits September 27, 2025 12:30

Merge branch 'master' into multiple-query-params-models

533907f

Merge branch 'master' into multiple-query-params-models

c361035

github-actions Bot added the conflicts Automatically generated when a PR has a merge conflict label Oct 11, 2025

This comment was marked as resolved.

Sign in to view

Merge branch 'master' into multiple-query-params-models

6910a5f

Copilot AI review requested due to automatic review settings December 11, 2025 21:58

github-actions Bot removed the conflicts Automatically generated when a PR has a merge conflict label Dec 11, 2025

Copilot started reviewing on behalf of uriyyo December 11, 2025 21:59 View session

Copilot AI reviewed Dec 11, 2025

View reviewed changes

Comment thread fastapi/dependencies/utils.py Outdated

Comment thread fastapi/dependencies/utils.py Outdated

github-actions Bot added the conflicts Automatically generated when a PR has a merge conflict label Dec 12, 2025

uriyyo and others added 4 commits February 5, 2026 21:11

Update fastapi/dependencies/utils.py

b61128b

Co-authored-by: Copilot <[email protected]>

Update fastapi/dependencies/utils.py

6013e08

Co-authored-by: Copilot <[email protected]>

Merge remote-tracking branch 'upstream/master' into multiple-query-pa…

f40e747

…rams-models

merge with main

e8d30d7

github-actions Bot removed the conflicts Automatically generated when a PR has a merge conflict label Feb 8, 2026

🎨 Auto format

846cef1

Fix alias in loc

ed24198

Uh oh!

Conversation

uriyyo commented Nov 16, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

wu-clan commented Nov 17, 2024

Uh oh!

uriyyo commented Nov 17, 2024

Uh oh!

jperuggia commented Jan 28, 2025

Uh oh!

Ale-Cas Feb 2, 2025

Choose a reason for hiding this comment

Uh oh!

uriyyo Aug 5, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Mulugruntz commented Mar 5, 2025

Uh oh!

Vaserty commented Mar 15, 2025

Uh oh!

uriyyo commented Aug 5, 2025

Uh oh!

bassemkaroui commented Aug 12, 2025

Uh oh!

bobbyo commented Sep 15, 2025

Uh oh!

This comment was marked as resolved.

bjmc commented Nov 20, 2025

Uh oh!

bjmc commented Nov 21, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

github-actions Bot commented Dec 12, 2025

Uh oh!

uriyyo commented Feb 8, 2026

Uh oh!

codspeed-hq Bot commented Feb 8, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

CodSpeed Performance Report

Merging this PR will not alter performance

Summary

Footnotes

Uh oh!

wu-clan commented Feb 8, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

11 participants

uriyyo commented Nov 16, 2024 •

edited

Loading

codspeed-hq Bot commented Feb 8, 2026 •

edited

Loading