Параметр description
Параметр description передаётся в конструктор класса
FastAPI
и задаёт подробное текстовое описание приложения.
Это описание попадает в схему OpenAPI и отображается
на страницах документации Swagger UI и ReDoc.
Значением параметра может быть обычная строка,
в том числе многострочная, либо строка в формате Markdown.
Синтаксис
app = FastAPI(description='...')
Пример
Давайте создадим приложение с описанием:
from fastapi import FastAPI
app = FastAPI(
title='My Application',
description='This is a sample application.'
)
@app.get('/')
def index():
return {'text': 'hello'}
Теперь при открытии страницы /docs под заголовком
будет отображаться переданное описание.
Пример
Описание можно оформить в формате Markdown с несколькими строками:
from fastapi import FastAPI
description = '''
## About
This API provides access to sample data.
- Endpoint / returns a greeting
- Endpoint /user/{name} returns a name
'''
app = FastAPI(
title='My Application',
description=description
)
@app.get('/')
def index():
return {'text': 'hello'}
Markdown в описании будет отрендерен в документации Swagger UI с заголовками и списками.
Пример
Давайте посмотрим, как описание попадает в схему OpenAPI:
<+python+>
from fastapi import FastAPI
app = FastAPI(
title='My Application',
version='1.0.0',
description='This is a sample application.'
)
@app.get('/')
def index():
return {'text': 'hello'}
<-python+>
Результат выполнения запроса к /openapi.json
(фрагмент):
{
"openapi": "3.1.0",
"info": {
"title": "My Application",
"description": "This is a sample application.",
"version": "1.0.0"
}
}
