FastAPI 使用 POST 请求将文件下载到客户端

Question

目前我在 FastAPI 和文件服务方面遇到了一些困难。

在我的项目中，我有以下工作流程。客户端发送一个有效负载，其中包含从第三方提供商下载文件所需的有效负载。

我需要向后端发送有效负载，这是必要的，并且由于创建了资源（下载文件），我假设 POST 将是此端点的方法，但让我向您展示一个例如。

from fastapi import FastAPI, Form
from fastapi.responses import FileResponse

import os

app = FastAPI()



@app.post("/download_file")
async def download():
    
    url = 'https://file-examples-com.github.io/uploads/2017/10/file-sample_150kB.pdf'
    os.system('wget %s'%url)
    

    return FileResponse("file-sample_150kB.pdf")


@app.get("/get_file")
async def get_file():
    return FileResponse("/home/josec/Whosebug_q/file-sample_150kB.pdf")

如果我访问 http://localhost:8000/get_file，我会在网页上显示文件！然而，这不是我要找的！我希望在客户端下载文件，通过浏览器或通过 cli！

以下脚本不会下载任何文件，除非您将其粘贴到您可以查看的浏览器中。

import requests

url = "http://localhost:8000/get_file"


response = requests.request("GET", url)

print(response.json())

这个也不行！

import requests

url = "http://localhost:8000/download_file"


response = requests.request("POST", url)

print(response.json())

我的问题是：

我应该只使用 GET 吗？如果是，我将如何在 url 上传递参数？我用 post 请求发送的一些字符串可能很长，不知道这是否是个问题。
我怎样才能return一个文件给用户？在函数端点的return语句中立即下载给用户！
我可以用 POST 做吗？

如果你们还需要我提供任何其他信息，请告诉我:-)

最佳，

何塞

Answer 1

我认为问题在于您没有指定文件类型，因此浏览器只是打开它。

在更高级的主题中，有关于如何定义文件 return 类型的说明。

https://fastapi.tiangolo.com/advanced/additional-responses/#additional-media-types-for-the-main-response

下面是取自文档的示例

    @app.get(
    "/items/{item_id}",
    response_model=Item,
    responses={
        200: {
            "content": {"image/png": {}},
            "description": "Return the JSON item or an image.",
        }
    },
)
async def read_item(item_id: str, img: Optional[bool] = None):
    if img:
        return FileResponse("image.png", media_type="image/png")
    else:
        return {"id": "foo", "value": "there goes my hero"}

如您所见，FileResponse 指定了媒体的类型，以便客户端知道如何处理它。

关于GET/POST的问题，我认为POST是正确的，因为你在创造一些东西，虽然我也认为反问你刚刚创造的数据是错误的。我的意思是，您刚刚发送了数据，现在您要询问相同的数据？在我看来这是错误的，但您也可以在 POST 请求完成后通过 GET 请求下载。

编辑

抱歉没有回复，我完全迷路了。

无论如何，关于你的第二个问题，现在我明白你的意图是让它以图形方式下载。这很简单：

使用ajax
获取 ajax 的结果并将其插入到 HTML 元素中
触发 HTML 元素的点击，用户将被询问文件保存位置（或下载刚刚开始，具体取决于用户在其系统上激活的设置）

下面的资源可以实现你要找的东西

通过 ajax 下载后，将内容插入到新创建的元素中，如

href 参数必须按照 Using HTML5/JavaScript to generate and save a file 中的方式进行编码。确切的数据类型取决于文件的数据类型。在任何搜索引擎上进行简单搜索即可提供所需的数据类型。

然后，您必须将刚刚创建的元素插入 HTML 中的某处并激活点击功能。

FastAPI 使用 POST 请求将文件下载到客户端

FastAPI download a file to client with a POST request

python-3.x

fastapi

编辑