api-design-patterns

| 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 لمشاريع FastAPI مع Pydantic v2. يُستخدم أثناء مرحلة التصميم عند تخطيط نقاط نهاية واجهة برمجة التطبيقات الجديدة، أو تحديد عقود الطلب/الاستجابة، أو تصميم ترقيم الصفحات أو التصفية، أو توحيد استجابات الأخطاء، أو التخطيط لإصدار واجهة برمجة التطبيقات. يغطي تسمية RESTful، ودلالات طريقة HTTP، واصطلاحات تسمية مخطط Pydantic v2 (XxxCreate/XxxUpdate/XxxResponse)، وترقيم الصفحات المستند إلى المؤشر، وتنسيق الخطأ القياسي، ووثائق OpenAPI. لا يغطي تفاصيل التنفيذ (استخدم python-backend-expert) أو البنية على مستوى النظام (استخدم بنية النظام). المصدر: hieutrtr/ai1-skills.