Dynamic Query Parameters in FastAPI

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, Aug 14 '22 at 17:26

score 1 · Accepted Answer · answered Aug 14 '22 at 17:27

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 '22 at 17:27

joaopfg

1,227
2
9
18

With the '...' do you mean other parameters? otherwise it's considered an error. Also in this way, Swagger can't add any documentation. – angeloandrea.isola Aug 14 '22 at 21:14
Yes, I was meaning your other parameters (path parameters, session etc) – joaopfg Aug 14 '22 at 21:17
Sorry, but if the query parameters aren't defined a priori, what Swagger UI should show ? – joaopfg Aug 14 '22 at 21:19

Dynamic Query Parameters in FastAPI

1 Answers1