Параметр alias
Параметр alias применяется в функциях
Path, Query, Header, Cookie, Body, Form и File.
Он позволяет указать альтернативное имя, под которым
параметр будет приходить в запросе. Это удобно, когда
внешнее имя параметра не совпадает с именем переменной
в Python (например, из-за стиля именования или
недопустимых символов). По умолчанию используется
имя переменной функции.
Синтаксис
Query(default=..., alias='external_name')
Path(default=..., alias='external_name')
Header(default=..., alias='external_name')
Cookie(default=..., alias='external_name')
Пример
Давайте примем query-параметр item-query,
а в Python-коде назовём переменную item_query:
from fastapi import FastAPI, Query
app = FastAPI()
@app.get('/items/')
def read_items(item_query: str = Query(alias='item-query')):
return {'item_query': item_query}
Результат выполнения кода для адреса /items/?item-query=abcde:
{"item_query": "abcde"}
Пример
Давайте примем path-параметр user-id,
а в Python-коде назовём переменную user_id:
from fastapi import FastAPI, Path
app = FastAPI()
@app.get('/users/{user-id}')
def read_user(user_id: int = Path(alias='user-id')):
return {'user_id': user_id}
Результат выполнения кода для адреса /users/5:
{"user_id": 5}
Пример
Давайте примем заголовок X-Token,
а в Python-коде назовём переменную x_token:
from fastapi import FastAPI, Header
app = FastAPI()
@app.get('/headers/')
def read_headers(x_token: str = Header(alias='X-Token')):
return {'x_token': x_token}
Результат выполнения кода для заголовка X-Token: abcde:
{"x_token": "abcde"}
