api-design-patterns

SKILL.md

| GET /v1/users | GET /v1/getUsers | No verbs — HTTP method implies action | | POST /v1/users | POST /v1/user/create | POST to collection = create | | GET /v1/order-items | GET /v1/orderItems | Kebab-case, not camelCase | | GET /v1/users/{id}/orders | GET /v1/users/{id}/orders/{oid}/items | Max 2 nesting levels |

| POST /v1/orders/{id}/actions/cancel | POST /v1/cancelOrder/{id} | Action sub-resource for non-CRUD |

| Method | Purpose | Request Body | Success Status | Idempotent |

API-Vertragsdesignkonventionen für FastAPI-Projekte mit Pydantic v2. Verwendung während der Entwurfsphase, wenn Sie neue API-Endpunkte planen, Anforderungs-/Antwortverträge definieren, Paginierung oder Filterung entwerfen, Fehlerantworten standardisieren oder die API-Versionierung planen. Behandelt RESTful-Benennung, HTTP-Methodensemantik, Pydantic v2-Schema-Namenskonventionen (XxxCreate/XxxUpdate/XxxResponse), Cursor-basierte Paginierung, Standardfehlerformat und OpenAPI-Dokumentation. Behandelt NICHT Implementierungsdetails (verwenden Sie python-backend-expert) oder Architektur auf Systemebene (verwenden Sie system-architecture). Quelle: hieutrtr/ai1-skills.

Original anzeigen