Pydantic：根据需要指定值但输入示例值

Question

我在 FastAPI 中使用 Pydantic，在 OpenAPI 文档中定义。意识到要根据需要定义值，我需要将值保留为空，如下所示。

class Item(BaseModel):
    name: str
    description: str
    price: float
    tax: float

但是，我想提供带有示例值的 JSON，我可以使用以下语法创建它。

class Item(BaseModel):
    name: str = "my name"
    description: str = "my description"
    price: float = 0.234
    tax: float = 0.20

但这将使它们成为 OpenAPI 文档中不需要的。有没有什么方法可以让我根据需要指定它们，并给出示例值？

Answer 1

基于文档Schema Extra - 示例：

Config.schema_extra您可以为您的额外声明BaseModel：

class Item(BaseModel):
    name: str
    description: str
    price: float
    tax: float

    class Config:
        schema_extra = {
            "example": {
                "name": "my name",
                "description": "my description",
                "price": 0.234,
                "tax": 0.20
            }
        }

或者使用以下方式显式声明pydantic.Field：

from pydantic import BaseModel, Field

class Item(BaseModel):
    name: str = Field(..., example="my name")
    description: str = Field(..., example="my description")
    price: float = Field(..., example=0.234)
    tax: float = Field(..., example=0.20)