FastAPI Statische Dateien

FastAPI kann bequem statische Dateien (wie Bilder, CSS-, JavaScript-Dateien) bereitstellen, mithilfe von StarlettesStaticFilesImplementierung.


Abhängigkeiten installieren

StaticFilesenthalten inaiofilesDarin müssen Sie installieren:

pip install aiofiles

Statisches Dateiverzeichnis mounten

Nutzungapp.mount()Statisches Dateiverzeichnis in die Anwendung mounten:

Beispiel

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Statisches Dateiverzeichnis mounten
# "/static" ist das URL-Pfadpräfix
# directory="static" ist der lokale Verzeichnisname
app.mount("/static", StaticFiles(directory="static"), name="static")


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

Code-Erklärung:

ParameterBeschreibung
"/static"URL-Pfadpräfix, z. B. beim Zugriff auf/static/logo.png
directory="static"Lokaler Verzeichnisname, der Ordner, der statische Dateien speichert
name="static"der intern verwendete Name, der zum Generieren von URLs verwendet wird (überurl_for)

mountbesteht darin, eine unabhängige "Sub-Anwendung" unter einem angegebenen Pfad zu mounten.StaticFilesist selbst eine ASGI-Anwendung, die für die Bearbeitung von Anfragen für statische Dateien zuständig ist. Nach dem Mounten werden alle Anfragen beginnend mit/staticAnfragen beginnend mit werden alle behandelt vonStaticFileswerden behandelt und durchlaufen nicht das Routing-System von FastAPI.


Beispiel-Verzeichnisstruktur

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

Zugriffsmethode:

DateipfadURL
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-Template-Rendering

FastAPI unterstützt die Jinja2-Template-Engine, die HTML-Seiten dynamisch rendern kann:

Beispiel

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

app = FastAPI()

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

# Jinja2-Template
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
        }
    )

Template-Dateitemplates/hello.html:

Beispiel

<!DOCTYPE html>
<html>
<head>
    <title>Hallo</title>
    <link rel="stylesheet" href="/static/css/style.css">
</head>
<body>
    <h1>Hallo, {{ name }}!</h1>
    <img src="/static/images/logo.png" alt="Logo">
</body>
</html>

Beim Rendern von Templates mussrequestobject übergeben werden, da das Template den Request-Kontext verwenden muss (z. B. zum Generieren von URLs usw.).


Zusammenfassung

  • NutzungStaticFilesStatische Dateien bereitstellen
  • Nutzungapp.mount()Das Verzeichnis für statische Dateien unter dem angegebenen Pfad einbinden
  • Die gemounteten Pfade für statische Dateien werden nicht vom Routing-System von FastAPI verwaltet.
  • In Kombination mit der Jinja2-Template-Engine kann das Rendern von HTML-Seiten erreicht werden.
  • Statische Dateien eignen sich zum Speichern von Ressourcen, die sich nicht dynamisch ändern, wie CSS, JS, Bilder usw.
Weitere Erweiterungen