Fichiers statiques FastAPI

FastAPI peut facilement servir des fichiers statiques (tels que des images, des fichiers CSS, JavaScript), en utilisant l'implémentation de StarletteStaticFilesImplémentation.


Installer les dépendances

StaticFilesinclus dansaiofilesPour cela, vous devez installer :

pip install aiofiles

Monter le répertoire des fichiers statiques

Utilisationapp.mount()Monter le répertoire des fichiers statiques sur l'application :

Exemple

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

# Monter le répertoire des fichiers statiques
# "/static" est le préfixe de chemin d'URL
# directory="static" est le nom du répertoire local
app.mount("/static", StaticFiles(directory="static"), name="static")


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

Explication du code :

ParamètreDescription
"/static"Préfixe de chemin d'URL, comme pour accéder à/static/logo.png
directory="static"Nom du répertoire local, le dossier qui stocke les fichiers statiques
name="static"le nom utilisé en interne, utilisé pour générer des URL (viaurl_for)

mountconsiste à monter une "sous-application" indépendante sur un chemin spécifié.StaticFilesest elle-même une application ASGI, responsable du traitement des requêtes de fichiers statiques. Après le montage, toutes les requêtes commençant par/staticLes requêtes commençant par sont toutes traitées parStaticFilessont traitées, et ne passeront pas par le système de routage de FastAPI.


Exemple de structure de répertoire

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

Méthode d'accès :

Chemin du fichierURL
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

Rendu de modèle HTML

FastAPI prend en charge le moteur de modèles Jinja2, qui peut rendre dynamiquement des pages HTML :

Exemple

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

app = FastAPI()

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

# Modèle 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
        }
    )

Fichier de modèletemplates/hello.html:

Exemple

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

Lors du rendu des modèles, il faut passerrequestun objet, car le modèle peut avoir besoin d'utiliser le contexte de la requête (comme la génération d'URL, etc.).


Résumé

  • UtilisationStaticFilesServir des fichiers statiques
  • Utilisationapp.mount()Monter le répertoire des fichiers statiques sur le chemin spécifié
  • Les chemins des fichiers statiques montés ne sont pas gérés par le système de routage de FastAPI.
  • Combiné avec le moteur de templates Jinja2, le rendu de pages HTML peut être réalisé.
  • Les fichiers statiques conviennent pour stocker des ressources qui ne changent pas dynamiquement, comme CSS, JS, les images, etc.
autres extensions