Параметр description
Параметр description применяется внутри функций
Path, Query, Header, Cookie, Body, Form и File
для задания текстового описания параметра.
Это описание отображается в автоматически генерируемой
документации Swagger UI и ReDoc.
Значением передаётся строка с пояснением для пользователя API.
Синтаксис
Path(description='текст описания')
Query(description='текст описания')
Header(description='текст описания')
Cookie(description='текст описания')
Body(description='текст описания')
Form(description='текст описания')
File(description='текст описания')
Пример
Давайте добавим описание к параметру пути user_id:
from fastapi import FastAPI, Path
app = FastAPI()
@app.get('/user/{user_id}')
def user(user_id: int = Path(description='ID пользователя')):
return {'user_id': user_id}
Результат выполнения кода для адреса /user/1:
{"user_id": 1}
Пример
Давайте добавим описание к query-параметру name:
<+python+>
from fastapi import FastAPI, Query
app = FastAPI()
@app.get('/user/')
def user(name: str = Query(description='Имя пользователя')):
return {'name': name}
<-python+>
Результат выполнения кода для адреса /user/?name=abcde:
{"name": "abcde"}
Пример
Давайте добавим описание к заголовку user_agent:
from fastapi import FastAPI, Header
app = FastAPI()
@app.get('/user/')
def user(user_agent: str = Header(description='User-Agent клиента')):
return {'user_agent': user_agent}
Результат выполнения кода:
{"user_agent": "abcde"}
Смотрите также
-
параметр
title,
который задаёт заголовок параметра -
параметр
examples,
который задаёт примеры значений параметра -
параметр
deprecated,
который помечает параметр как устаревший -
функция
Query,
которая описывает query-параметр запроса
