Шаблон Jinja2

В этой главе вы научитесь настраивать движок шаблонов Jinja2 в FastAPI, используя статические файлы и наследование шаблонов для создания полноценных HTML-страниц.


Два режима рендеринга FastAPI

FastAPI по умолчанию возвращает JSON (подходит для API), но также может возвращать HTML (подходит для SSR).

Эти два режима могут сосуществовать — один и тот же проект может одновременно предоставлять JSON API и рендерить веб-страницы.


Монтирование статических файлов

Статические файлы (CSS, JS, изображения) обрабатываются черезStaticFilesСмонтировать по указанному пути.

Пример

# Путь к файлу: main.py
from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Смонтировать каталог static/ по пути /static
# Доступ к /static/css/style.css → фактически читает static/css/style.css
app.mount("/static", StaticFiles(directory="static"), name="static")

Ссылки на статические файлы в шаблонах:

Пример

<link rel="stylesheet" href="/static/css/style.css">
<img src="/static/images/logo.png">

Настройте шаблоны Jinja2

Пример

# Путь к файлу: main.py
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")

# Укажите каталог шаблонов
templates = Jinja2Templates(directory="templates")

@app.get("/")
def index(request: Request):       # Примечание: маршрут шаблона должен принимать параметр Request.
    """Главная страница блога"""
    return templates.TemplateResponse(
        "index.html",              # Имя файла шаблона
        {                          # данные контекста
            "request": request,    # request должен быть передан (требование Jinja2Templates)
            "title": "ПРИМЕР блога"
        }
    )

Рендеринг шаблонов в FastAPI имеет два ключевых отличия от Flask: 1. Функция представления должна приниматьrequest: Requestпараметр; 2.requestДолжен быть передан в шаблон как контекст. Если request опущен, функция url_for в шаблоне не сработает.


Создайте родительский шаблон base.html

Пример

<!-- Путь к файлу: templates/base.html -->
<!DOCTYPE html>
<html lang="zh-CN">
<head>
    <meta charset="UTF-8">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>{% block title %}EXAMPLE Blog{% endblock %}</title>
    <link rel="stylesheet" href="/static/css/style.css">
    {% block extra_head %}{% endblock %}
</head>
<body>
    <header class="navbar">
        <a href="/" class="logo">EXAMPLE Blog (FastAPI)</a>
        <nav>
            <a href="/">Главная</a>
            <a href="#">О нас</a>
        </nav>
    </header>

    <main class="container">
        {% block content %}{% endblock %}
    </main>

    <footer class="footer">
        <p>© 2024 EXAMPLE Blog. Работает на FastAPI.</p>
    </footer>
</body>
</html>

Создайте дочерний шаблон index.html

Пример

<!-- Путь к файлу: templates/index.html -->
{% extends 'base.html' %}

{% block title %}{{ title }}{% endblock %}

{% block content %}
<h2 class="section-title">Последние статьи</h2>
<p>Список статей будет отображаться в следующих главах.</p>
{% endblock %}

url_for() в шаблонах FastAPI

Как и Flask, FastAPI также поддерживаетurl_for(), но сначала нужно назвать маршрут.

Пример

@app.get("/post/{post_id}", name="post_detail")   # name= задаёт имя маршрута
def post_detail(request: Request, post_id: int):
    return templates.TemplateResponse("post_detail.html",
        {"request": request, ...})

Пример

<!-- Ссылка в шаблоне -->
<a href="{{ url_for('post_detail', post_id=3) }}">Статья 3</a>

Создайте базовые стили CSS

Пример

/* Путь к файлу: static/css/style.css */
* { margin: 0; padding: 0; box-sizing: border-box; }

body {
    font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, sans-serif;
    background: #f5f5f5;
    color: #333;
}

.navbar {
    display: flex; justify-content: space-between; align-items: center;
    padding: 16px 40px; background: #fff;
    box-shadow: 0 2px 8px rgba(0,0,0,0.1);
}

.navbar .logo {
    font-size: 22px; font-weight: bold;
    color: #009688; text-decoration: none;
}

.navbar nav a {
    margin-left: 20px; text-decoration: none; color: #333;
}

.container { max-width: 960px; margin: 40px auto; padding: 0 20px; }

.footer { text-align: center; padding: 20px; color: #999; border-top: 1px solid #eee; }

.section-title { font-size: 24px; margin-bottom: 20px; }

Итоги главы

В этой главе вы узнали о конфигурации рендеринга фронтенда в FastAPI: StaticFiles для монтирования статических ресурсов, Jinja2Templates для настройки каталога шаблонов, TemplateResponse для возврата HTML, а также ключевые отличия от Flask в рендеринге шаблонов (необходимо передавать параметр Request).

Другие расширения