FastAPI-Body、Field

参考:模式的额外信息 - 例子 - FastAPI

在FastAPI中,BodyField是两个常用的注解,它们用于定义请求体中的数据或路径参数、查询参数等的处理方式。这两个注解都来自于Pydantic库,用于数据验证和解析,但它们的应用场景有所不同。

Body

Body是一个注解,用来指示FastAPI从HTTP请求的主体(即请求体)中读取数据,并根据提供的模型或类型进行解析和验证。当期望客户端通过POST、PUT等方法发送JSON对象或其他格式的数据时,就会用到Body它常与Pydantic的模型类一起使用来定义请求体的结构

Field

Field是Pydantic模型类中用于定义模型字段属性的一个方法。它允许你为模型的字段添加额外的元数据,比如默认值、标题、描述等Field通常不直接用于FastAPI的路由定义中,而是用于定义Pydantic模型的结构,这些模型随后可能作为Body、查询参数、路径参数等使用。

举例:

from typing import List, Set, Union, Optional
import uvicorn
from fastapi import FastAPI, Body
from pydantic import BaseModel, HttpUrl, Field
from typing_extensions import Annotated

# 初始化FastAPI应用程序
app = FastAPI()

# 定义Item模型,表示商品项的属性
class Item(BaseModel):
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None

# 定义Item_1模型,与Item类似,但提供了更详细的字段示例
class Item_1(BaseModel):
    name: str = Field(examples=["Foo"])
    description: Union[str, None] = Field(default=None, examples=["A very nice Item"])
    price: float = Field(examples=[35.4])
    tax: Union[float, None] = Field(default=None, examples=[3.2])

# 更新物品信息的API端点
# 接收一个item_id参数和一个Item实例作为请求体
@app.put("/items/{item_id}")
async def update_item(item_id: int, item: Item):
    results = {"item_id": item_id, "item": item}
    return results

# 另一个更新物品信息的API端点,使用了更详细的Annotated注解来指定请求体的期望格式
@app.put("/items_1/{item_id}")
async def update_item(
        item_id: int,
        item: Annotated[
            Item_1,
            Body(
                examples=[
                    {
                        "name": "Foo",
                        "description": "A very nice Item",
                        "price": 35.4,
                        "tax": 3.2,
                    }
                ],
            ),
        ],
):
    results = {"item_id": item_id, "item": item}
    return results

# 主函数,用于启动FastAPI应用程序
# 注释中提供了两种运行模式:线上模式和调试模式
# 主函数,用于启动FastAPI应用程序
if __name__ == "__main__":
    ## 线上模式
    # uvicorn.run("abr_server:app", host="0.0.0.0", port = 1218)

    ## debug 模式
    uvicorn.run("test4:app", host="0.0.0.0", port=1218, reload=True, )

### FastAPI 第三方库列表 FastAPI 的生态系统非常活跃,有许多第三方库可以帮助开发者更高效地构建应用程序。以下是部分流行的 FastAPI 扩展库: #### 1. 数据库集成 - **Tortoise ORM**: 支持异步操作的ORM工具,适用于MySQL、PostgreSQL等数据库[^1]。 ```python from tortoise.models import Model from tortoise import fields class User(Model): id = fields.IntField(pk=True) username = fields.CharField(max_length=50) class Meta: table="users" ``` #### 2. 认证授权 - **fastapi-users**: 提供用户管理功能,包括注册、登录等功能[^3]。 ```python from fastapi_users import FastAPIUsers from fastapi_users.db import TortoiseBaseUserModel, TortoiseUserDatabase class UserModel(TortoiseBaseUserModel): pass user_db = TortoiseUserDatabase(UserModel) fastapi_users = FastAPIUsers(user_db) ``` #### 3. 日志记录 - **loguru**: 高级的日志处理模块,简化日志配置过程。 ```python import loguru logger = loguru.logger.add("file.log", rotation="5 MB") logger.info("An informational message.") ``` #### 4. 缓存支持 - **fastapi-cache2**: 增加缓存机制来提高性能,减少重复计算的时间开销。 ```python from fastapi_cache.decorator import cache @app.get("/") @cache(expire=60) # Cache this endpoint's response for 60 seconds. async def read_main(): return {"msg": "Hello World"} ``` #### 5. 文件上传下载 - **fastapi-multipart-formdata-parser**: 方便解析multipart/form-data类型的请求体,特别适合文件上传场景。 ```python from starlette.requests import Request from multipart_formdata_parser import parse_multipart_formdata @app.post("/upload/") async def upload_file(request: Request): form_data = await parse_multipart_formdata(await request.body()) file_content = form_data["file"].content filename = form_data["file"].filename ... ```
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值