Параметр title
Параметр title используется в функциях Path,
Query, Header, Cookie, Body
и других для указания человекочитаемого заголовка параметра.
Этот заголовок отображается в автоматической документации
Swagger UI и ReDoc. По умолчанию вместо заголовка
показывается имя параметра.
Значением параметра title является строка.
Он передаётся как именованный аргумент в функцию объявления
параметра.
Синтаксис
Query(default, title='...')
Path(default, title='...')
Header(default, title='...')
Cookie(default, title='...')
Body(default, title='...')
Пример
Давайте зададим заголовок для query-параметра name:
from fastapi import FastAPI, Query
app = FastAPI()
@app.get('/user/')
def user(name: str = Query(default='abcde', title='User name')):
return {'name': name}
В документации /docs параметр отобразится с заголовком
User name вместо name.
Пример
Давайте зададим заголовок для path-параметра user_id:
from fastapi import FastAPI, Path
app = FastAPI()
@app.get('/user/{user_id}')
def user(user_id: int = Path(title='User ID')):
return {'user_id': user_id}
Результат выполнения кода для адреса /user/1:
{"user_id": 1}
Пример
Давайте зададим заголовок для header-параметра user_agent:
from fastapi import FastAPI, Header
app = FastAPI()
@app.get('/')
def index(user_agent: str = Header(default='', title='User Agent')):
return {'user_agent': user_agent}
Заголовок User Agent появится в документации
для заголовка запроса.
Смотрите также
-
параметр
description,
который задаёт описание параметра -
параметр
alias,
который задаёт альтернативное имя параметра -
функция
Query,
которая объявляет query-параметр -
функция
Path,
которая объявляет path-параметр
