FastAPI GET request converting some query parameters to a request body [duplicate]

Question

I'm using the following schemas for my FastAPI Get request:

class JWTClaims(BaseModel):
    iat: int
    exp: int
    aud: Optional[Union[str, List[str]]]
    iss: str
    sub: str
    azp: str


class AccessClaims(JWTClaims):
    scope: str


@router.get("/client")
async def get_user_client(claims:AccessClaims = Depends()):
    pass

FastAPI is trying to convert the aud field as part of a request body- how can I eliminate this so that it becomes a valid GET request?

That doesn't get rid of the request body. I can delete the contents of the request body and it works however this aud field will be populated at various points so I can't use this as a solution — equatorial_daydreamer
– equatorial_daydreamer, Commented Sep 7, 2022 at 14:08
one more idea.. aud: Optional[Union[str, List[str]]] = Query(default=None), of course you need from fastapi import Query — vaizki
– vaizki, Commented Sep 7, 2022 at 14:17
As noted in Chris link this isn't currently possible - the limitation is documented in the reference guide: "To declare a query parameter with a type of list, like in the example above, you need to explicitly use Query, otherwise it would be interpreted as a request body." — MatsLindh
– MatsLindh, Commented Sep 7, 2022 at 20:29

ndclt · Accepted Answer · 2022-09-07 14:41:37Z

Here a workaround, you can add the aud as argument of the route like this:

class JWTClaims(BaseModel):
    iat: int
    exp: int
    iss: str
    sub: str
    azp: str


class AccessClaims(JWTClaims):
    scope: str


app = FastAPI()


# as argument it works
@app.get("/client")
async def get_user_client(aud: Optional[List[str]] = Query(None), claims:AccessClaims = Depends()):
    return

And you have the aud in the swagger. It will be a list but, users can supply only one if they want.

For reason I don't understand, doing this in the class doesn't work:

class JWTClaims(BaseModel):
    iat: int
    exp: int
    aud: Optional[List[str]] = Query(None)
    iss: str
    sub: str
    azp: str

If you're really want the Optional[str, List[str]], you will need to have it as a body request:

@app.get("/client")
async def get_user_client(aud: Optional[Union[str, List[str]]] = Query(None), claims:AccessClaims = Depends()):
    return

leads to this error when loading the app:

    async def get_user_client(aud: Optional[Union[str, List[str]]] = Query(None), claims:AccessClaims = Depends()):
  File "/home/stackoverflow/lib/python3.10/site-packages/fastapi/routing.py", line 626, in decorator
    self.add_api_route(
  File "/home/stackoverflow/lib/python3.10/site-packages/fastapi/routing.py", line 565, in add_api_route
    route = route_class(
  File "/home/stackoverflow/lib/python3.10/site-packages/fastapi/routing.py", line 434, in __init__
    self.dependant = get_dependant(path=self.path_format, call=self.endpoint)
  File "/home/stackoverflow/lib/python3.10/site-packages/fastapi/dependencies/utils.py", line 322, in get_dependant
    assert isinstance(
AssertionError: Param: aud can only be a request body, using Body()

Collectives™ on Stack Overflow

FastAPI GET request converting some query parameters to a request body [duplicate]

1 Answer 1

Comments

Linked

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Linked

Related