Класс FastAPI

Класс FastAPI применяется для создания главного объекта приложения. Экземпляр класса хранит маршруты, настройки OpenAPI, зависимости, middleware и обработчики событий. Первым параметром можно передать заголовок приложения, также доступны параметры version, debug, docs_url, redoc_url, lifespan, dependencies и другие.

Синтаксис

from fastapi import FastAPI

app = FastAPI(
	title='...',
	version='...',
	debug=False
)

Пример

Давайте создадим приложение и повесим обработчик на адрес '/':

from fastapi import FastAPI

app = FastAPI()

@app.get('/')
def index():
	return {'text': 'hello'}

Результат выполнения кода:

{"text": "hello"}

Пример

Давайте передадим заголовок и версию приложения:

from fastapi import FastAPI

app = FastAPI(
	title='My Application',
	version='1.0.0'
)

@app.get('/')
def index():
	return {'title': app.title, 'version': app.version}

Результат выполнения кода:

{"title": "My Application", "version": "1.0.0"}

Пример

Давайте включим режим отладки и отключим документацию:

from fastapi import FastAPI

app = FastAPI(
	debug=True,
	docs_url=None,
	redoc_url=None
)

@app.get('/')
def index():
	return {'debug': app.debug}

Результат выполнения кода:

{"debug": true}

Пример

Давайте запустим приложение через терминал:

uvicorn main:app --reload

После запуска приложение будет доступно по адресу http://127.0.0.1:8000, а интерактивная документация по адресу http://127.0.0.1:8000/docs.

Смотрите также

метод get,
который вешает обработчик на GET-запрос
метод post,
который вешает обработчик на POST-запрос
метод include_router,
который подключает роутер к приложению
метод mount,
который монтирует подприложение по указанному пути