FastAPI 在 FastAPI 中从静态文件夹中列出文件

在本文中，我们将介绍如何在 FastAPI 中从静态文件夹中列出文件。FastAPI 是一个现代且高性能的Web框架，它使用Python进行开发，并具有出色的性能和易用性。静态文件是指在服务器上存储并供Web应用程序使用的文件，例如图片、CSS样式表或JavaScript脚本。

阅读更多：FastAPI 教程

设置静态文件夹

首先，我们需要设置FastAPI应用程序以识别和提供静态文件。为此，我们需要使用StaticFiles来创建一个StaticFiles实例，并将其添加到FastAPI应用程序的app对象中。

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")

在上述代码中，我们通过使用StaticFiles类并指定静态文件的目录来创建一个StaticFiles实例。然后，通过使用app.mount方法将此StaticFiles实例挂载到app对象上。在这个例子中，我们将静态文件的URL路径设置为/static，并将其目录设置为static。你可以根据需要设置不同的路径和目录。

列出文件

一旦我们设置了静态文件夹，我们就可以通过发送HTTP请求来列出其中的文件。假设我们的静态文件夹中有一些图片文件（.jpg和.png），我们可以通过创建一个新的路由来实现列出文件的功能。

from fastapi import FastAPI, HTTPException
from fastapi.staticfiles import StaticFiles
import os

app = FastAPI()

app.mount("/static", StaticFiles(directory="static"), name="static")

@app.get("/files")
async def list_files():
    files = []
    for filename in os.listdir("static"):
        if filename.endswith((".jpg", ".png")):
            files.append(filename)
    if not files:
        raise HTTPException(status_code=404, detail="No files found")
    return {"files": files}

在上述代码中，我们使用os.listdir函数遍历静态文件夹中的所有文件名，并将其存储在一个列表中。我们使用endswith方法来筛选出具有指定扩展名的文件（.jpg和.png）。如果未找到任何文件，我们则抛出一个HTTP异常。如果找到了文件，则将它们作为响应返回。

测试应用程序

要测试我们的应用程序，我们可以使用浏览器或一个HTTP客户端工具（例如curl或Postman）来发送HTTP GET请求到/files路径。如果静态文件夹中存在图片文件，我们将收到一个包含文件列表的响应。

下面是一个使用curl命令行工具发送HTTP请求的示例：

curl http://localhost:8000/files

响应的示例：

{
  "files": [
    "image1.jpg",
    "image2.png",
    "image3.jpg"
  ]
}

总结

本文介绍了如何在 FastAPI 中从静态文件夹中列出文件。我们首先设置了一个名为StaticFiles的实例，并将其挂载到 FastAPI 应用程序上。然后，我们创建了一个新的路由，并使用os.listdir函数列出了静态文件夹中的文件。最后，我们通过发送 HTTP 请求来测试应用程序，并验证了响应是否包含了正确的文件列表。

FastAPI 提供了灵活而方便的功能，使我们能够轻松地使用静态文件，并以简洁的方式对其进行操作。无论是构建一个简单的静态文件列表，还是创建一个复杂的 Web 应用程序，FastAPI 都是一个强大的选择。希望这篇文章对你有所帮助，并能够了解如何在 FastAPI 中列出静态文件。