在FastAPI中,响应模型用于定义API路由返回的数据结构。通过使用响应模型,你可以指定路由的返回值的数据类型,以及在文档中进行展示。以下是一个简单的FastAPI教程示例,演示如何使用响应模型:

首先,确保你已经安装了FastAPI和uvicorn:
pip install fastapi uvicorn

然后,创建一个名为main.py的文件,输入以下代码:
from fastapi import FastAPI

app = FastAPI()

# 响应模型
class ItemResponse:
    def __init__(self, name: str, description: str):
        self.name = name
        self.description = description

# 定义路由,指定响应模型
@app.get("/items/{item_id}", response_model=ItemResponse)
async def read_item(item_id: int):
    item_name = f"Item {item_id}"
    item_description = f"Description of Item {item_id}"
    return ItemResponse(name=item_name, description=item_description)

在这个例子中,我们定义了一个响应模型ItemResponse,它有两个属性:name和description。然后,在read_item路由中,我们通过response_model参数指定了返回的数据类型为ItemResponse。

你可以使用[httpie](https://httpie.io/)或其他工具来测试这个API。以下是一个使用httpie的示例:
http "http://127.0.0.1:8000/items/1"

在上面的命令中,我们向 /items/1 发送了一个GET请求,FastAPI将返回一个符合ItemResponse模型的JSON响应。




转载请注明出处:http://www.pingtaimeng.com/article/detail/7373/FastAPI