Dynamically creating get request taking query parameter list based on Pydantic schema

Question

I'm able to get requests like this with query parameters of a type list like this:

@router.get("/findStuff")
def get_stuff(a: List[int] = Query(None), b: List[str] = Query(None)):
    return {'a': a, 'b': b}

But I'm not sure how I'd do this dynamically from an arbitrary Pydantic schema? When I do this, the query params are interpreted as a request body and cannot be processed from the OpenAPI doc. Is there a way to get the same behavior from above without explicitly specifying each query param in the method arguments?

class MySchema(BaseModel):
    a: List[int] = Query(None)
    b: List[str] = Query(None)

@router.get("/findStuff")
def get_stuff(inputs: MySchema = Depends()):
    return inputs

Josh · Accepted Answer · 2021-09-10 05:01:11Z

2

The FastAPI documentation outlines how you can declare classes as dependencies.

An example based on the code you provided in your question:

import uvicorn
from typing import List
from fastapi import FastAPI, Depends, Query

app = FastAPI()

class MySchema:
    def __init__(self, a: List[int] = Query(None), b: List[str] = Query(None)):
        self.a = a
        self.b = b

@app.get("/findStuff")
def get_stuff(inputs: MySchema = Depends()):
    return inputs

if __name__ == "__main__":
    uvicorn.run(app='main:app', host='127.0.0.1', port=8000)

If you navigate to the documentation (/docs endpoint), you can see the query paramaters for that route:

answered Sep 10, 2021 at 5:01

Josh

2,0061 gold badge14 silver badges23 bronze badges

Sign up to request clarification or add additional context in comments.

3 Comments

Victor Over a year ago

Thanks! Similar to this, I found that using a dataclass instead of a Pydantic schema works.

Josh Over a year ago

no problem! if this was useful to you, please consider accepting this answer.

Sohail Ahmed Over a year ago

Hi @Josh, How can we define the parameters in redoc documentation request sample?

Collectives™ on Stack Overflow

Dynamically creating get request taking query parameter list based on Pydantic schema

1 Answer 1

3 Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Your Answer

Sign up or log in

Post as a guest

Related