Параметр summary

Параметр summary передаётся в конструктор класса FastAPI и задаёт краткое описание всего приложения. Это описание отображается в документации Swagger и ReDoc рядом с заголовком title. Значением параметра является строка.

Синтаксис

app = FastAPI(summary='...')

Пример

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

from fastapi import FastAPI

app = FastAPI(
	title='My Application',
	summary='A short description of my application'
)

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

После запуска сервера и открытия адреса /docs в Swagger рядом с заголовком 'My Application' появится текст 'A short description of my application'.

Пример

Давайте проверим значение параметра через атрибут openapi_schema:

from fastapi import FastAPI

app = FastAPI(
	title='My Application',
	summary='A short description of my application'
)

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

res = app.openapi()
print(res['info']['summary'])

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

"A short description of my application"

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

класс FastAPI,
который создаёт приложение и принимает параметр summary
параметр description,
который задаёт подробное описание приложения
атрибут title,
который задаёт заголовок приложения
атрибут version,
который задаёт версию приложения