FastAPI与自定义Pydantic通用Schema：自动生成示例全攻略

引言

在现代化API开发中，FastAPI以其高性能和易用性脱颖而出。结合Pydantic进行数据验证和序列化，更是如虎添翼。本文将深入探讨如何使用自定义Pydantic通用Schema，并在FastAPI中自动生成示例。

FastAPI与Pydantic简介

FastAPI

FastAPI是一个现代、快速（高性能）的Web框架，用于构建APIs。它基于标准Python类型提示，具备自动数据验证、序列化等功能。

Pydantic

Pydantic是一个数据验证和设置管理的库，使用Python类型提示进行数据验证。

自定义Pydantic通用Schema

什么是通用Schema

通用Schema允许我们定义可复用的数据结构，减少代码冗余。

定义通用Schema

以下是一个简单的通用Schema示例：

from pydantic import BaseModel

class Item(BaseModel):
    id: int
    name: str
    price: float

在FastAPI中使用自定义Schema

创建FastAPI应用

首先，我们需要创建一个FastAPI应用：

from fastapi import FastAPI

app = FastAPI()

添加路由

使用自定义Schema添加一个路由：

@app.get("/items/{item_id}", response_model=Item)
def read_item(item_id: int):
    return {
        "id": item_id,
        "name": "Example Item",
        "price": 19.99
    }

自动生成示例

使用Pydantic的Config

Pydantic的Config类允许我们自定义Schema的行为。通过设置json_schema_extra，我们可以自动生成示例：

class Item(BaseModel):
    id: int
    name: str
    price: float
    
    class Config:
        json_schema_extra = {
            "example": {
                "id": 1,
                "name": "Sample Item",
                "price": 9.99
            }
        }

在FastAPI中查看示例

启动FastAPI应用后，访问Swagger UI，可以看到自动生成的示例。

总结

通过自定义Pydantic通用Schema并结合FastAPI，我们可以高效地构建健壮的API，并自动生成示例，提升开发体验和文档质量。

希望本文能帮助你在FastAPI和Pydantic的使用上更进一步！