pydantic-models-py

Pydantic モデル

クリーンな API コントラクトのために、マルチモデルパターンに従って Pydantic モデルを作成します。

クイックスタート

以下のインラインモデルパターンを使用し、クラス名とフィールドを実際の API コントラクトに合わせて調整してください。構成構文を選択する前に、インストールされている Pydantic のバージョンを確認してください。これらの断片は、プロジェクトで示されているインポートとアプリケーションの型を必要とします。スタンドアロンのテンプレートファイルが同梱されていると想定しないでください。

マルチモデルパターン

モデル	目的
Base	モデル間で共有される共通フィールド
Create	作成用のリクエストボディ（必須フィールド）
Update	更新用のリクエストボディ（すべて任意）
Response	すべてのフィールドを含む API レスポンス
InDB	doc_type を持つデータベースドキュメント

camelCase エイリアス

class MyModel(BaseModel):
    workspace_id: str = Field(..., alias="workspaceId")
    created_at: datetime = Field(..., alias="createdAt")
    
    class Config:
        populate_by_name = True  # Accept both snake_case and camelCase

任意の更新フィールド

class MyUpdate(BaseModel):
    """All fields optional for PATCH requests."""
    name: Optional[str] = Field(None, min_length=1)
    description: Optional[str] = None

データベースドキュメント

class MyInDB(MyResponse):
    """Adds doc_type for Cosmos DB queries."""
    doc_type: str = "my_resource"

統合手順

1. src/backend/app/models/ にモデルを作成します
2. src/backend/app/models/__init__.py からエクスポートします
3. 対応する TypeScript の型を追加します

使用する場合

このスキルは、概要に記載されたワークフローを実行する場合に適用できます。

制限事項

• このスキルは、タスクが上記のスコープに明確に一致する場合にのみ使用してください。
• 出力を、環境固有の検証、テスト、専門家によるレビューの代替として扱わないでください。
• 必要な入力、権限、安全境界、成功基準が欠けている場合は、停止して確認を求めてください。