Атрибут title

Атрибут title хранит название приложения FastAPI. Значение задаётся при создании экземпляра класса FastAPI через одноимённый параметр и попадает в поле info.title OpenAPI-схемы. Это название отображается в заголовке страницы Swagger и в документации ReDoc.

Если параметр title не указан, FastAPI подставляет значение по умолчанию - строку 'FastAPI'. Прочитать текущее название можно через атрибут app.title.

Синтаксис

app = FastAPI(title='My Application')

Пример

Давайте создадим приложение с названием 'Article API':

from fastapi import FastAPI

app = FastAPI(title='Article API')

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

Название появится в заголовке страницы /docs и в поле info.title OpenAPI-схемы по адресу /openapi.json:

{"info": {"title": "Article API", "version": "0.1.0"}}

Пример

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

from fastapi import FastAPI

app = FastAPI(title='Article API')

@app.get('/title')
def get_title():
	return {'title': app.title}

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

{"title": "Article API"}

Пример

Давайте убедимся, что без параметра title используется значение по умолчанию:

<+python+> from fastapi import FastAPI app = FastAPI() @app.get('/title') def get_title(): return {'title': app.title} <-python+>

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

{"title": "FastAPI"}

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

класс FastAPI,
который создаёт приложение
атрибут version,
который задаёт версию приложения
атрибут openapi_schema,
который хранит OpenAPI-схему приложения
метод openapi,
который возвращает OpenAPI-схему приложения