Параметр description
Параметр description передаётся в конструктор класса
FastAPI и задаёт текстовое описание приложения.
Это описание попадает в схему OpenAPI и отображается
в интерактивной документации по адресу /docs
и /redoc. Принимает строку или многострочный текст,
может содержать Markdown-разметку.
Синтаксис
app = FastAPI(description='...')
Пример
Давайте создадим приложение с описанием:
from fastapi import FastAPI
app = FastAPI(
title='My API',
description='This is a simple API built with FastAPI.'
)
@app.get('/')
def index():
return {'text': 'hello'}
Теперь описание видно в документации по адресу /docs
и в схеме OpenAPI по адресу /openapi.json.
Пример
Давайте используем многострочное описание с Markdown-разметкой:
from fastapi import FastAPI
description = """
## Users API
This API allows you to:
* get a user by name
* get a list of all users
"""
app = FastAPI(
title='Users API',
description=description
)
@app.get('/users')
def users():
return [{'name': 'abcde'}, {'name': 'user'}]
Результат выполнения кода для адреса /users:
[{"name": "abcde"}, {"name": "user"}]
Пример
Давайте проверим, что описание попало в схему OpenAPI:
from fastapi import FastAPI
app = FastAPI(
title='My API',
description='This is a simple API built with FastAPI.'
)
@app.get('/')
def index():
return {'text': 'hello'}
res = app.openapi()
print(res['info']['description'])
Результат выполнения кода:
"This is a simple API built with FastAPI."
