Когда вы объявляете другие параметры функции, которые не являются частью
параметров пути, они автоматически интерпретируются как параметры
«запроса» (query parameters).
В этом случае параметр функции q будет необязательным и по умолчанию будет равен None.
Совет
Также обратите внимание, что FastAPI достаточно умён, чтобы определить, что параметр пути item_id является параметром пути, а q — нет, поэтому q является параметром запроса.
Вы также можете объявлять типы bool, и они будут преобразованы:
fromfastapiimportFastAPIapp=FastAPI()@app.get("/items/{item_id}")asyncdefread_item(item_id:str,q:str|None=None,short:bool=False):item={"item_id":item_id}ifq:item.update({"q":q})ifnotshort:item.update({"description":"This is an amazing item that has a long description"})returnitem
В этом случае, если вы перейдёте по:
http://127.0.0.1:8000/items/foo?short=1
или
http://127.0.0.1:8000/items/foo?short=True
или
http://127.0.0.1:8000/items/foo?short=true
или
http://127.0.0.1:8000/items/foo?short=on
или
http://127.0.0.1:8000/items/foo?short=yes
или при любой другой вариации регистра (верхний регистр, первая буква заглавная и т. д.), ваша функция увидит параметр short со значением bool, равным True. В противном случае — False.
Вы можете объявлять несколько параметров пути и параметров запроса одновременно, FastAPI знает, что есть что.
И вам не нужно объявлять их в каком-либо определённом порядке.
Они будут обнаружены по имени:
fromfastapiimportFastAPIapp=FastAPI()@app.get("/users/{user_id}/items/{item_id}")asyncdefread_user_item(user_id:int,item_id:str,q:str|None=None,short:bool=False):item={"item_id":item_id,"owner_id":user_id}ifq:item.update({"q":q})ifnotshort:item.update({"description":"This is an amazing item that has a long description"})returnitem
И конечно, вы можете определить некоторые параметры как обязательные, некоторые — как имеющие значение по умолчанию, а некоторые — как полностью необязательные: