Статические файлы FastAPI

FastAPI может удобно обслуживать статические файлы (такие как изображения, файлы CSS, JavaScript), используя StarletteStaticFilesРеализация.


Установите зависимости

StaticFilesвключено вaiofilesВ, вам нужно установить:

pip install aiofiles

Смонтировать каталог статических файлов

Использованиеapp.mount()Смонтировать каталог статических файлов в приложение:

Пример

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Смонтировать каталог статических файлов
# "/static" — это префикс пути URL
# directory="static" — это имя локальной директории
app.mount("/static", StaticFiles(directory="static"), name="static")


@app.get("/")
async def root():
    return {"message": "Hello World"}

Пояснение к коду:

ПараметрОписание
"/static"Префикс пути URL, например, при доступе/static/logo.png
directory="static"Имя локальной директории — папка, в которой хранятся статические файлы
name="static"внутреннее имя, используемое для генерации URL (черезurl_for)

mountзаключается в монтировании независимого «суб-приложения» на указанный путь.StaticFilesсам является ASGI-приложением, отвечающим за обработку запросов к статическим файлам. После монтирования все запросы, начинающиеся с/staticВсе запросы, начинающиеся с, обрабатываютсяStaticFilesобрабатываются и не проходят через систему маршрутизации FastAPI.


Пример структуры каталога

project/
├── main.py
└── static/
    ├── css/
    │   └── style.css
    ├── js/
    │   └── app.js
    └── images/
        └── logo.png

Способ доступа:

Путь к файлуURL
static/css/style.csshttp://127.0.0.1:8000/static/css/style.css
static/js/app.jshttp://127.0.0.1:8000/static/js/app.js
static/images/logo.pnghttp://127.0.0.1:8000/static/images/logo.png

Рендеринг HTML-шаблонов

FastAPI поддерживает движок шаблонов Jinja2, который может динамически рендерить HTML-страницы:

Пример

from fastapi import FastAPI, Request
from fastapi.staticfiles import StaticFiles
from fastapi.templating import Jinja2Templates

app = FastAPI()

# Статические файлы
app.mount(
    "/static",
    StaticFiles(directory="static"),
    name="static"
)

# Шаблон Jinja2
templates = Jinja2Templates(
    directory="templates"
)


@app.get("/hello/{name}")
async def hello(request: Request, name: str):
    return templates.TemplateResponse(
        request=request,
        name="hello.html",
        context={
            "name": name
        }
    )

Файл шаблонаtemplates/hello.html:

Пример

<!DOCTYPE html>
<html>
<head>
    <title>Привет</title>
    <link rel="stylesheet" href="/static/css/style.css">
</head>
<body>
    <h1>Привет, {{ name }}!</h1>
    <img src="/static/images/logo.png" alt="Логотип">
</body>
</html>

При рендеринге шаблонов необходимо передатьrequestобъект, потому что шаблону может потребоваться использовать контекст запроса (например, для генерации URL и т. д.).


Итог

  • ИспользованиеStaticFilesОбслуживание статических файлов
  • Использованиеapp.mount()Смонтируйте каталог статических файлов по указанному пути
  • Смонтированные пути к статическим файлам не управляются системой маршрутизации FastAPI.
  • В сочетании с шаблонизатором Jinja2 можно реализовать рендеринг HTML-страниц.
  • Статические файлы подходят для хранения ресурсов, которые не изменяются динамически, таких как CSS, JS, изображения и т. д.
Другие расширения