fastapi 实体参数

FastAPI 中的实体参数（通常称为数据模型或Python数据结构）是用来描述请求或响应中预期的数据结构的。它们可以是自定义 Python 类，其中包含用于表示 API 数据字段的属性。当 FastAPI 接收到请求时，会期望这些字段按指定的结构存在。你可以像这样定义一个实体参数：

from pydantic import BaseModel

class UserInput(BaseModel):
    name: str
    email: str
    age: int

@app.post("/users", response_model=UserOutput)
async def create_user(user: UserInput):
    # 这里 user 就是一个 UserInput 对象，包含了 name、email 和 age 字段
    created_user = await db.create_user(name=user.name, email=user.email, age=user.age)
    return created_user

在这个例子中，`UserInput` 是一个模型，`create_user` 函数接受一个 `UserInput` 参数，并将其传递给数据库操作。

相关问题

fastapi Body参数

FastAPI中的`Body`参数是一种特殊的路径参数，用于接收客户端通过HTTP请求体发送的数据。当你在路由装饰器中使用`Body(...)`，FastAPI会在解析请求时自动读取并解码请求体的内容。`Body`可以接受多种数据类型，包括JSON、表单数据（multipart/form-data）、XML等，具体取决于`Content-Type`头的设置。

例如，创建一个POST API来接收JSON数据：

from fastapi import FastAPI, Request

app = FastAPI()

@app.post("/items/")
async def create_item(request: Request):
    item_data = await request.json()
    # item_data现在就是一个字典，你可以访问其中的字段
    name = item_data["name"]
    price = item_data["price"]
    return {"item_name": name, "item_price": price}

在这个例子中，如果客户端发送了一个包含`{"name": "foo", "price": 123}`的POST请求到`/items/`，`create_item`函数将接收到对应的JSON数据。

fastapi 请求参数校验

FastAPI是一个现代、快速的Web框架，用于构建API，具有自动交互式文档和强类型数据验证。FastAPI使用Pydantic库进行数据验证，Pydantic会根据Python类型提示自动推断出数据的类型，并且在数据到达时进行校验。

在FastAPI中，你可以通过在函数参数前添加类型注解来实现请求参数的校验。FastAPI会自动将请求的数据（包括路径参数、查询参数、请求体等）转换为相应的Python类型，并进行校验。如果校验失败，FastAPI将自动返回一个合适的HTTP错误响应。

例如，如果你有一个API端点，它期望接收一个名为`item_id`的路径参数和一个名为`q`的查询参数，你可以这样做：

from fastapi import FastAPI, Path, Query

app = FastAPI()

@app.get("/items/{item_id}")
async def read_item(item_id: int = Path(..., title="The ID of the item to get"),
                    q: str = Query(..., min_length=3, max_length=50, title="Query string"),
                    short: bool = False):
    return {"item_id": item_id, "q": q, "short": short}

在这个例子中，`item_id`必须是一个整数，`q`是一个长度在3到50个字符之间的字符串。如果请求中提供的数据不符合这些要求，FastAPI会自动抛出`HTTPException`，并且返回一个状态码为422（Unprocessable Entity）的响应。

FastAPI还支持更复杂的校验，比如数字范围、正则表达式匹配、嵌套模型校验等。