如何将URL作为路径参数传递给FastAPI路由？

Question

我已经使用FastAPI创建了一个简单的API，我正在尝试将URL作为任意的＜code＞路径＜/code＞参数传递给FastAPI路由。

from fastapi import FastAPI
app = FastAPI()
@app.post("/{path}")
def pred_image(path:str):
    print("path",path)
    return {'path':path}

当我测试它时，它不起作用并抛出错误。我以这种方式测试它：

http://127.0.0.1:8000/https://raw.githubusercontent.com/ultralytics/yolov5/master/data/images/zidane.jpg

Answer 1

您可以简单地使用< code>path转换器来捕获任意路径。根据Starlette文档，< code>path返回路径的其余部分，包括任何附加的< code>/字符。

from fastapi import Request

@app.get('/{_:path}')
def pred_image(request: Request):
    return {"path": request.url.path[1:]}

或者

@app.get("/{full_path:path}")
def pred_image(full_path: str):
    return {"path": full_path}

使用以下方法进行测试:

http://127.0.0.1:8000/https://raw.githubusercontent.com/ultralytics/yolov5/master/data/images/zidane.jpg

输出：

{"path":"https://raw.githubusercontent.com/ultralytics/yolov5/master/data/images/zidane.jpg"}

正如@luk2302在评论部分提到的，您的客户端（即最终用户、javascript等）需要对URL进行编码。但是，@luk2302提供的编码URL似乎不起作用，导致“详细信息”：“未找到”错误。事实证明，您需要对其进行两次编码才能工作。即：

http://127.0.0.1:8000/https%253A%252F%252Fraw.githubusercontent.com%252Fultralytics%252Fyolov5%252Fmaster%252Fdata%252Fimages%252Fzidane.jpg

在服务器端，您可以按如下方式解码URL（两次）：

from urllib.parse import unquote 

@app.get("/{path}")
def pred_image(path: str):
    return {'path':unquote(unquote(path))}  

由于您的endpoint似乎接受POST请求，您可以考虑让客户端在请求正文中发送图像URL，而不是将其作为路径参数传递。请查看此处、此处和此处的答案，以及FastAPI的留档，了解如何做到这一点。

如果您通过在浏览器的地址栏中键入上述URL来测试这一点，那么请继续使用@app.get（）路由，因为当您在浏览器的地址栏中键入URL时，它会执行GET请求。但是，如果您需要它来处理POST请求，您将不得不将endpoint的装饰器更改为@app.post（）（如您的问题所示）；否则，您将遇到{"详细信息"："方法不允许"}错误。