Jinja2-Vorlage

In diesem Kapitel lernst du, die Jinja2-Template-Engine in FastAPI zu konfigurieren und dabei statische Dateien und Template-Vererbung zu verwenden, um vollständige HTML-Seiten zu erstellen.


Die zwei Rendering-Modi von FastAPI

FastAPI gibt standardmäßig JSON zurück (geeignet für APIs), kann aber auch HTML zurückgeben (geeignet für SSR).

Die beiden Modi können koexistieren—dasselbe Projekt kann sowohl eine JSON-API bereitstellen als auch Webseiten rendern.


Statische Dateien einbinden

Statische Dateien (CSS, JS, Bilder) werden überStaticFilesAn den angegebenen Pfad mounten.

Beispiel

# Dateipfad: main.py
from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Binde das Verzeichnis static/ an den Pfad /static ein
# Zugriff auf /static/css/style.css → liest tatsächlich static/css/style.css
app.mount("/static", StaticFiles(directory="static"), name="static")

Verweise auf statische Dateien in Templates:

Beispiel

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

Jinja2-Templates konfigurieren

Beispiel

# Dateipfad: 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")

# Template-Verzeichnis angeben
templates = Jinja2Templates(directory="templates")

@app.get("/")
def index(request: Request):       # Hinweis: Die Template-Route muss einen Request-Parameter empfangen.
    """Blog-Startseite"""
    return templates.TemplateResponse(
        "index.html",              # Template-Dateiname
        {                          # Kontextdaten
            "request": request,    # request muss übergeben werden (Jinja2Templates-Anforderung)
            "title": "BEISPIEL-Blog"
        }
    )

Das Template-Rendering von FastAPI unterscheidet sich in zwei wesentlichen Punkten von Flask: 1. Die View-Funktion mussrequest: RequestParameter; 2.requestMuss als Kontext an das Template übergeben werden. Wenn request weggelassen wird, schlägt die url_for-Funktion im Template fehl.


Erstellen Sie das übergeordnete Template base.html

Beispiel

<!-- Dateipfad: 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">BEISPIEL Blog (FastAPI)</a>
        <nav>
            <a href="/">Startseite</a>
            <a href="#">Über uns</a>
        </nav>
    </header>

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

    <footer class="footer">
        <p>© 2024 BEISPIEL Blog. Bereitgestellt von FastAPI.</p>
    </footer>
</body>
</html>

Erstelle das untergeordnete Template index.html

Beispiel

<!-- Dateipfad: templates/index.html -->
{% extends 'base.html' %}

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

{% block content %}
<h2 class="section-title">Neueste Artikel</h2>
<p>Die Artikelliste wird in späteren Kapiteln angezeigt.</p>
{% endblock %}

url_for() in FastAPI-Vorlagen

Ähnlich wie Flask unterstützt FastAPI auchurl_for(), aber du musst zuerst die Route benennen.

Beispiel

@app.get("/post/{post_id}", name="post_detail")   # name= benennt die Route
def post_detail(request: Request, post_id: int):
    return templates.TemplateResponse("post_detail.html",
        {"request": request, ...})

Beispiel

<!-- Referenz im Template -->
<a href="{{ url_for('post_detail', post_id=3) }}">Artikel 3</a>

Grundlegende CSS-Stile erstellen

Beispiel

/* Dateipfad: 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; }

Kapitelzusammenfassung

In diesem Kapitel haben Sie die Konfiguration des Frontend-Renderings in FastAPI kennengelernt: StaticFiles zum Einbinden statischer Ressourcen, Jinja2Templates zum Konfigurieren des Template-Verzeichnisses, TemplateResponse zum Zurückgeben von HTML und die wichtigsten Unterschiede zu Flask beim Template-Rendering (der Request-Parameter muss übergeben werden).

Weitere Erweiterungen