Что касается создания надежных и масштабируемых API, FastAPI завоевал значительную популярность в сообществе Python. Одной из важных особенностей FastAPI является возможность легко обрабатывать необязательные параметры. В этом сообщении блога мы углубимся в различные методы работы с необязательными параметрами в FastAPI, сопровождаемые разговорными объяснениями и практическими примерами кода.

Метод 1: значения по умолчанию
Самый простой способ определить необязательный параметр в FastAPI — присвоить ему значение по умолчанию. При этом, если параметр не указан в запросе API, FastAPI автоматически будет использовать значение по умолчанию.

from fastapi import FastAPI
app = FastAPI()
@app.get("/items/")
async def get_items(limit: int = 10):
    return {"message": f"Returning {limit} items"}

В этом примере параметр limitявляется необязательным, и если он не указан, по умолчанию он равен 10.

Метод 2: Параметры запроса
FastAPI позволяет определять необязательные параметры в качестве параметров запроса. Параметры запроса добавляются к URL-адресу после вопросительного знака (?), что позволяет клиентам передавать на сервер дополнительные данные.

from fastapi import FastAPI
app = FastAPI()
@app.get("/items/")
async def get_items(limit: int = 10, category: str = None):
    items = {"limit": limit, "category": category}
    return items

Здесь параметры limitи categoryявляются необязательными. Параметр limitимеет значение по умолчанию 10, а параметр categoryпо умолчанию имеет значение None.

Метод 3: Параметры пути
Параметры пути — отличный способ определить необязательные параметры, являющиеся частью пути URL. FastAPI позволяет пометить параметр пути как необязательный, указав значение по умолчанию.

from fastapi import FastAPI
app = FastAPI()
@app.get("/items/{item_id}")
async def get_item(item_id: int, details: bool = False):
    item = {"item_id": item_id, "details": details}
    return item

В этом примере параметр detailsявляется необязательным, и если он не указан, по умолчанию он равен False. Параметр item_idявляется обязательным и должен быть включен в URL-путь.

Метод 4: тело запроса
Если вы предпочитаете передавать необязательные параметры как часть тела запроса, FastAPI упрощает это. Вы можете определить модель Pydantic с необязательными полями и использовать ее в качестве типа тела запроса.

from fastapi import FastAPI
from pydantic import BaseModel
app = FastAPI()
class Item(BaseModel):
    name: str
    price: float
    description: str = None
@app.post("/items/")
async def create_item(item: Item):
    return item

В этом примере поле descriptionв теле запроса является необязательным. Если этот параметр не указан, по умолчанию используется значение None.

Понимание того, как работать с необязательными параметрами в FastAPI, имеет решающее значение для создания гибких и удобных API. В этой статье мы рассмотрели несколько методов, включая значения по умолчанию, параметры запроса, параметры пути и тела запроса. Используя эти методы, вы можете создавать API, которые корректно обрабатывают необязательные параметры, повышая общее удобство использования.

Не забудьте поэкспериментировать с этими методами и выбрать тот, который лучше всего соответствует вашему дизайну API. Приятного программирования с помощью FastAPI!