Wie werden benutzerdefinierte HTML-Dateien anstelle von index.html im Stammpfad von FastAPI bereitgestellt?

Benutzerdefinierte HTML-Dateien anstelle von Index.html im FastAPI-Stammpfad bereitstellen

In FastAPI können Sie statische Dateien, einschließlich HTML, mithilfe der StaticFiles-Middleware bereitstellen. Die Verwendung von StaticFiles für den Root-Pfad (/) kann jedoch zu unerwartetem Verhalten führen, da index.html automatisch für das Root-Verzeichnis bereitgestellt wird.

Warum index.html anstelle von benutzerdefiniertem HTML bereitgestellt wird

Laut der [Starlette-Dokumentation](https://www.starlette.io/static-files/) verfügt StaticFiles über eine HTML-Option, die, wenn sie auf True gesetzt ist, automatisch index.html für Verzeichnisse lädt wenn eine solche Datei vorhanden ist.

Lösung: Mounten Sie StaticFiles in einem anderen Pfad

Um Ihre benutzerdefinierte HTML-Datei korrekt im Stammpfad darzustellen, mounten Sie StaticFiles in einem anderen Pfad, z. B. /static:

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles

app = FastAPI()

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

Montagereihenfolge ist wichtig

Die Reihenfolge, in der Sie StaticFiles mounten und Ihre Endpunkte definieren, ist entscheidend. Wenn Sie StaticFiles nach der Definition Ihres Root-Endpunkts bereitstellen, hat der Root-Endpunkt Vorrang und die benutzerdefinierte HTML-Datei wird bereitgestellt.

HTML=True-Option entfernen

Wenn Sie verschiedene HTML-Dateien bereitstellen möchten dynamisch sind und über zusätzliche Endpunkte verfügen, wird empfohlen, die Option html=True aus StaticFiles zu entfernen und FastAPIs zu verwenden [Vorlagen](https://fastapi.tiangolo.com/templates/) stattdessen.

Fazit

Indem Sie sich mit der Reihenfolge und Konfiguration von StaticFiles befassen, können Sie stattdessen Ihre benutzerdefinierte HTML-Datei bereitstellen index.html im Root-Pfad und ermöglicht gleichzeitig zusätzliche API-Endpunkte. Berücksichtigen Sie die Option „html=True“ je nach Ihrem spezifischen Anwendungsfall sorgfältig.

Das obige ist der detaillierte Inhalt vonWie werden benutzerdefinierte HTML-Dateien anstelle von index.html im Stammpfad von FastAPI bereitgestellt?. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!