Написать стартовую страницу приложения с инструкцией как в Readme

[ArtemBalandin81]

Why?

Когда пользователь входит на стартовую страницу приложения http://127.0.0.1:8001/ - ничего не происоходит и он получает ответ {"detail":"Not Found"}

Однако, в FastApi можно смонтировать статичные файлы, в т.ч. и главную страницу с инструкцией использования приложения

How To Do?

• Написать главную страницу приложения с инструкцией.
• Инструкцию и примеры кода взять из Readme.
• Пример реализации есть тут: https://metanit.com/python/fastapi/1.9.php

[ArtemBalandin81]

Для определения интерфейса для работы с сервером нередко используются html-страницы, то есть cтатические файлы с кодом html, которые могут использовать какие-то другие статические файлы - файлы стилей css, изображений, скриптов javascript и т.д. Для работы со статическими файлами FastAPI предоставляет удобный и компактный функционал, который располагается в пакете fastapi.staticfiles. В частности, для обслуживания статических файлов в определенном каталоге применяется класс StaticFiles, конструктор которого имеет следующую сигнатуру:

StaticFiles(directory=None, packages=None, html=False, check_dir=True)

То есть при обращении по пути "/static" приложение будет посылать в ответ файлы из каталога "public".
Запустим приложение и обратимся по пути http://127.0.0.1:8000/static/index.html, и приложение в ответ пришлет нам файл index.html:
В файле main.py для обслуживания статических файлов из каталога public определим следующий код:

from fastapi import FastAPI
from fastapi.staticfiles import StaticFiles
 
app = FastAPI()
 
app.mount("/static", StaticFiles(directory="public", html=True))

html=True
Теперь мы можем обратиться по пути http://127.0.0.1:8000/static/, и сервер также пришлет нам страницу index.html:

Подобным образом можно установить главную страницу и для всего веб-приложения:
app.mount("/", StaticFiles(directory="public", html=True))