Pydantic字段元数据指南：从基础到企业级文档增强
title: Pydantic字段元数据指南：从基础到企业级文档增强
from pydantic import BaseModel, Field
class Product(BaseModel):
sku: str = Field(
...,
title="产品SKU",
description="国际标准商品编号",
json_schema_extra={
"x-frontend": {"widget": "search-input"},
"example": "IPHONE-15-PRO"
}
)
print(Product.schema()["properties"]["sku"])
{
"title": "产品SKU",
"description": "国际标准商品编号",
"type": "string",
"x-frontend": {
"widget": "search-input"
},
"example": "IPHONE-15-PRO"
}
from pydantic import BaseModel, ConfigDict
class EnvAwareField(BaseModel):
model_config = ConfigDict(extra="allow")
@classmethod
def __get_pydantic_json_schema__(cls, core_schema, handler):
schema = handler(core_schema)
if os.getenv("ENV") == "prod":
schema["properties"]["api_key"]["x-mask"] = "partial"
return schema
class SecureAPI(EnvAwareField):
api_key: str
class BaseMetadata:
@classmethod
def apply_metadata(cls, field_name: str, schema: dict):
schema[field_name].update({
"x-requirements": ["ssl", "encryption"],
"x-audit": True
})
class PaymentModel(BaseMetadata, BaseModel):
card_number: str = Field(..., json_schema_extra={"x-component": "credit-card"})
@classmethod
def __get_pydantic_json_schema__(cls, *args):
schema = super().__get_pydantic_json_schema__(*args)
cls.apply_metadata("card_number", schema)
return schema
class OpenAPIExtensions(BaseModel):
class Config:
json_schema_extra = {
"components": {
"securitySchemes": {
"OAuth2": {
"type": "oauth2",
"flows": {
"implicit": {
"authorizationUrl": "/auth",
"scopes": {"read": "全局读取权限"}
}
}
}
}
}
}
class SecureEndpoint(OpenAPIExtensions):
data: str
from pydantic import BaseModel, Field
from typing import Dict
class I18NField(BaseModel):
translations: Dict[str, Dict[str, str]] = {
"zh": {"name": "姓名", "error": "格式错误"},
"en": {"name": "Name", "error": "Invalid format"}
}
@classmethod
def build_field_schema(cls, field_name: str, lang: str):
return {
field_name: {
"title": cls.translations[lang][field_name],
"x-error": cls.translations[lang]["error"]
}
}
class UserForm(I18NField):
name: str = Field(..., json_schema_extra=I18NField.build_field_schema("name", "zh"))
class FrontendIntegration(BaseModel):
location: str = Field(
...,
json_schema_extra={
"x-component": "map-picker",
"x-props": {
"apiKey": "GOOGLE_MAPS_KEY",
"defaultZoom": 12
}
}
)
class AuditableField(BaseModel):
@classmethod
def __get_pydantic_json_schema__(cls, core_schema, handler):
schema = handler(core_schema)
for field in cls.__fields__.values():
if field.json_schema_extra.get("x-audit"):
schema["properties"][field.name]["x-log"] = {
"level": "WARNING",
"frequency": "DAILY"
}
return schema
class AuditModel(AuditableField):
salary: float = Field(..., json_schema_extra={"x-audit": True})
from pydantic import ValidationError
try:
class InvalidMetadata(BaseModel):
data: str = Field(..., json_schema_extra={"x-type": 123})
except ValidationError as e:
print(f"元数据类型错误: {e}")
from functools import lru_cache
class OptimizedSchema(BaseModel):
@classmethod
@lru_cache(maxsize=128)
def schema(cls, **kwargs):
return super().schema(**kwargs)
class HighPerformanceModel(OptimizedSchema):
# 高频访问模型字段定义
| 错误码 | 现象 | 解决方案 |
|---|---|---|
| 422 | 元数据类型不匹配 | 检查json_schema_extra值类型 |
| 500 | 动态元数据生成失败 | 验证__get_pydantic_json_schema__实现 |
| 400 | 缺失必需扩展字段 | 配置默认值或可选参数 |
| 406 | 不支持的文档格式 | 添加Accept请求头指定格式 |
评论
发表评论