Как обслуживать определенный HTML-файл в корневом пути FastAPI при использовании StaticFiles

При использовании FastAPI вместе со StaticFiles для обслуживания статических файлов вы могут возникнуть ситуации, когда вы хотите загрузить другой файл HTML (например, custom.html) в корневой путь вместо файла index.html по умолчанию. Этого можно достичь, понимая определенные аспекты маршрутизации FastAPI и функциональности StaticFiles.

Понимание StaticFiles

Согласно документации Starlette, StaticFiles — это промежуточное программное обеспечение, которое обрабатывает обработку статических файлов из указанный каталог. Когда установлено значение html=True, он автоматически ищет файлы index.html в каталогах и обслуживает их соответствующим образом.

Порядок установки

Порядок монтирования StaticFiles и определения вашего конечные точки играют решающую роль. Если StaticFiles смонтирован по корневому пути (т. е. /) и определен перед любыми конечными точками, он будет иметь приоритет и обрабатывать все запросы, даже если пользовательские конечные точки будут определены позже.

Настройка корневого пути

Чтобы разместить определенный HTML-файл в корневом пути, вам необходимо выполнить следующие действия: шаги:

1. Подключите StaticFiles к отдельному пути (например, /static):

   app.mount('/static', StaticFiles(directory='static'))

2. Создайте пользовательскую конечную точку, которая возвращает нужный HTML-код. файл:

   @app.get('/')
   async def index():
       return FileResponse('custom.html')

3. Подключите StaticFiles после определения пользовательской конечной точки, чтобы обеспечить приоритет конечной точки.

Дополнительные соображения

• Убедитесь, что custom.html расположен в правильном каталоге, указанном при монтировании StaticFiles. path.
• Поймите, что если StaticFiles обработает запрос и не найдет файл по запрошенному пути, он вернет ответ 404 Not Found.
• Использование шаблонов вместо FileResponse обеспечивает большую гибкость для динамическое обновление HTML-файлов.