Параметр summary
Параметр summary передаётся в конструктор класса FastAPI
и задаёт краткое описание приложения.
Это описание отображается в заголовке автоматической документации
Swagger UI и ReDoc, а также попадает в OpenAPI-схему.
Если параметр не указан, в документации используется значение
по умолчанию - заголовок приложения.
Синтаксис
app = FastAPI(summary='...')
Пример
Давайте создадим приложение с кратким описанием:
from fastapi import FastAPI
app = FastAPI(
title='My Application',
summary='A short summary of my application'
)
@app.get('/')
def index():
return {'text': 'hello'}
Теперь в документации по адресу /docs будет отображаться
заголовок 'My Application' и краткое описание
'A short summary of my application'.
Пример
Давайте посмотрим, как summary попадает в OpenAPI-схему:
from fastapi import FastAPI
app = FastAPI(
title='My Application',
summary='A short summary of my application'
)
@app.get('/')
def index():
return {'text': 'hello'}
print(app.openapi()['info'])
Результат выполнения кода:
{'title': 'My Application', 'summary': 'A short summary of my application'}
Смотрите также
-
класс
FastAPI,
который создаёт приложение FastAPI -
параметр
description,
который задаёт полное описание приложения -
атрибут
title,
который задаёт заголовок приложения -
атрибут
openapi_schema,
который содержит OpenAPI-схему приложения
