Cannot pass URL Encoded string containing '/' as path parameter to GET endpoint

First Check

• I added a very descriptive title to this issue.
• I used the GitHub search to find a similar issue and didn’t find it.
• I searched the FastAPI documentation, with the integrated search.
• I already searched in Google “How to X in FastAPI” and didn’t find any information.
• I already read and followed all the tutorial in the docs and didn’t find an answer.
• I already checked if it is not related to FastAPI but to Pydantic.
• I already checked if it is not related to FastAPI but to Swagger UI.
• I already checked if it is not related to FastAPI but to ReDoc.

Commit to Help

• I commit to help with one of those options 👆

Example Code

@app.get('/images/thumbnail/{filename}',
  response_description="Returns a thumbnail image",
  response_class="StreamingResponse",
  responses= {200: {"description": "an image", "content": {"image/jpeg": {}}}})
async def thumbnail_image (filename: str):

Description

I have an endpoint that needs to take a filename (or path to filename) parameter string that could be something like “myimage.jpg” (which works) or something like “path/to/myimage.jpg” (which doesn’t work)

http://localhost:8000/images/thumbnail/landscapes%2FIMG_1462.jpeg does not enter the endpoint above and gets back a 404

I’ve tried removing the {filename} path param to form a regular query parameter but it doesn’t help. I am using the Javascript encodeURIComponent to create the string that is being sent as the parameter.

Operating System

macOS

Operating System Details

No response

FastAPI Version

0.70.1

Python Version

3.8

Additional Context

No response

[ypsah]

Reading about it again, it looks like starlette supports a path convertor.

The following should do what you want:

from fastapi import FastAPI

app = FastAPI()

@app.get('/images/thumbnail/{filename:path})
async def thumbnail_image(filename: str) -> str:
    """
    A thumbnail image
    """
    return filename

[d13g0]

Hi, my workaround to this issue was passing a base64 encoded variable in the querystring. My FastAPI endpoint looks like this:

from base64 import urlsafe_b64decode

@router.get('/my_route')
def my_endpoint(url:str = None):
    
    if url is None:
           raise HTTPException(...)
           
    parsed_url = urlsafe_b64decode(url)
    crud.operation(parsed_url,...)