FastAPI-请求体

参考网站： 请求体 - FastAPI

梳理内容：请求体

from typing import Union

from fastapi import FastAPI
from pydantic import BaseModel
import uvicorn


class Item(BaseModel):
    """
    商品项模型，定义商品的基本属性。
    
    参数:
    - name: 商品名称，字符串类型。
    - description: 商品描述，可为字符串或None。
    - price: 商品价格，浮点数类型。
    - tax: 商品税额，可为浮点数或None。
    """
    name: str
    description: Union[str, None] = None
    price: float
    tax: Union[float, None] = None


app = FastAPI()


@app.post("/items/")
async def create_item(item: Item):
    """
    创建商品项。

    接收一个Item对象作为请求体，直接返回该对象。
    """
    return item


# 使用模型
@app.post("/items11/")
async def create_item(item: Item):
    """
    创建商品项，并计算含税价格。

    接收一个Item对象作为请求体。如果商品项有税额，计算并返回含税价格。
    """
    item_dict = item.dict()
    if item.tax:
        price_with_tax = item.price + item.tax
        item_dict.update({"price_with_tax": price_with_tax})
    return item_dict


# 请求体 + 路径参数
@app.put("/items12/{item_id}")
async def update_item(item_id: int, item: Item):
    """
    更新指定ID的商品项。

    接收一个整数类型的item_id和一个Item对象作为请求体，返回更新后的商品项信息，包括商品ID。
    """
    return {"item_id": item_id, **item.dict()}


# 请求体 + 路径参数 + 查询参数
@app.put("/items13/{item_id}")
async def update_item(item_id: int, item: Item, q: Union[str, None] = None):
    """
    更新指定ID的商品项，并可接收查询参数。

    接收一个整数类型的item_id，一个Item对象和一个可选的字符串类型的查询参数q。返回更新后的商品项信息，包括商品ID。如果提供了查询参数q，将其包含在返回结果中。
    """
    result = {"item_id": item_id, **item.dict()}
    if q:
        result.update({"q": q})
    return result


# 主函数，用于启动FastAPI应用程序
if __name__ == "__main__":
    ## 线上模式
    # uvicorn.run("abr_server:app", host="0.0.0.0", port = 1213)

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