Dynamic Query Parameters in FastAPI [duplicate]

Question

I have a requirement to send dynamic query parameters to REST web service GET method [as shown below].

host:port/app?field1=value1&&field2=value2&....

The consumer can send parameters up to fieldn and valuen. Each field maps to the value.

With this type of requirement, I can't code a finite set of QueryParams on the server side method.

I'm using python and fastapi

Thanks.

My question is how do I take an arbitrary amount of parameters in the query — angeloandrea.isola
– angeloandrea.isola, Commented Aug 14, 2022 at 17:26

joaopfg · Accepted Answer · 2022-08-14 17:27:42Z

1

The idea to pass an arbitrary number of query parameters to the endpoint is to use the Request class provided by FastAPI. It gives a dict with all the query parameters you passed to the endpoint. Write your endpoint like the following:

@app.get("/app")
def read(..., request: Request):
    query_parameters_dict = request.query_params
    ...

answered Aug 14, 2022 at 17:27

joaopfg

1,2972 gold badges11 silver badges18 bronze badges

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

3 Comments

angeloandrea.isola Over a year ago

With the '...' do you mean other parameters? otherwise it's considered an error. Also in this way, Swagger can't add any documentation.

joaopfg Over a year ago

Yes, I was meaning your other parameters (path parameters, session etc)

joaopfg Over a year ago

Sorry, but if the query parameters aren't defined a priori, what Swagger UI should show ?

Collectives™ on Stack Overflow

Dynamic Query Parameters in FastAPI [duplicate]

1 Answer 1

3 Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

3 Comments

Linked

Related