Heim
pydantic-models-py
microsoft/skills
Erstellen Sie Pydantic-Modelle nach dem Multi-Model-Muster mit den Varianten Base, Create, Update, Response und InDB für saubere API-Verträge in Python-Anwendungen unter Verwendung von Pydantic v2.
...Alle erweiternPydantic-Modelle
Erstellen Sie Pydantic-Modelle gemäß dem Multi-Model-Muster für saubere API-Verträge.
Schnellstart
Kopieren Sie die Vorlage aus assets/template.py und ersetzen Sie die Platzhalter:
{{ResourceName}}→ PascalCase-Name (z. B.Project){{resource_name}}→ snake_case-Name (z. B.project)
Multi-Model-Muster
| Modell | Zweck |
|---|---|
| `Base` | Gemeinsame Felder, die über Modelle hinweg geteilt werden |
| `Create` | Anfragekörper zur Erstellung (erforderliche Felder) |
| `Update` | Anfragekörper für Aktualisierungen (alle optional) |
| `Response` | API-Antwort mit allen Feldern |
| `InDB` | Datenbankdokument mit `doc_type` |
camelCase-Aliasnamen
class MyModel(BaseModel):
workspace_id: str = Field(..., alias="workspaceId")
created_at: datetime = Field(..., alias="createdAt")
class Config:
populate_by_name = True # Akzeptiert sowohl snake_case als auch camelCase
Optionale Aktualisierungsfelder
class MyUpdate(BaseModel):
"""Alle Felder optional für PATCH-Anfragen."""
name: Optional[str] = Field(None, min_length=1)
description: Optional[str] = None
Datenbankdokument
class MyInDB(MyResponse):
"""Fügt doc_type für Cosmos DB-Abfragen hinzu."""
doc_type: str = "my_resource"
Integrationsschritte
- Erstellen Sie Modelle in
src/backend/app/models/ - Exportieren Sie aus
src/backend/app/models/__init__.py - Fügen Sie die entsprechenden TypeScript-Typen hinzu
---
name: pydantic-models-py
description: Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants for clean API contracts in Python applications using Pydantic v2.
license: MIT
---
# Pydantic Models
Create Pydantic models following the multi-model pattern for clean API contracts.
## Quick Start
Copy the template from [assets/template.py](assets/template.py) and replace placeholders:
- `{{ResourceName}}` → PascalCase name (e.g., `Project`)
- `{{resource_name}}` → snake_case name (e.g., `project`)
## Multi-Model Pattern
| Model | Purpose |
|-------|---------|
| `Base` | Common fields shared across models |
| `Create` | Request body for creation (required fields) |
| `Update` | Request body for updates (all optional) |
| `Response` | API response with all fields |
| `InDB` | Database document with `doc_type` |
## camelCase Aliases
```python
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
```
## Optional Update Fields
```python
class MyUpdate(BaseModel):
"""All fields optional for PATCH requests."""
name: Optional[str] = Field(None, min_length=1)
description: Optional[str] = None
```
## Database Document
```python
class MyInDB(MyResponse):
"""Adds doc_type for Cosmos DB queries."""
doc_type: str = "my_resource"
```
## Integration Steps
1. Create models in `src/backend/app/models/`
2. Export from `src/backend/app/models/__init__.py`
3. Add corresponding TypeScript types
Alle Dateien
0 Dateienpydantic-models-py installieren
Laden Sie die Skill-Dateien herunter und extrahieren Sie diese in Ihr .claude/skills/-Verzeichnis.
ZIP herunterladenKlonen Sie das Repository und kopieren Sie die Skill-Dateien in Ihr Projekt.
git clone https://github.com/microsoft/skills/tree/main/.github/plugins/azure-sdk-python/skills/pydantic-models-py # Copy SKILL.md to your .claude/skills/ directory
Kopieren
