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/stackoverflow_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 吗？如果是，我将如何在网址上传递参数？我通过发布请求发送的一些字符串可能会很长，不知道这是否会成为问题。

• 如何将文件返回给用户？在函数端点的返回语句中立即将其下载给用户！

• 我可以用 POST 来做吗？

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

最好的，

何塞

Answer 1

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

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

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 通过 javascript 下载文件
• 获取 ajax 的结果并将其插入到 HTML 元素中
• 触发 HTML 元素的点击，用户将被询问保存文件的位置（或者下载刚刚开始，具体取决于用户在其系统上激活的设置）

下面的资源可实现您想要的目标

通过ajax下载后，将内容插入到新创建的元素中，如如何使用javascript下载文件？

href 参数必须按照使用 HTML5/JavaScript 生成并保存文件中的方式进行编码。确切的数据类型取决于文件的数据类型。在任何搜索引擎上进行简单搜索都将提供所需的数据类型。

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