الاصطلاحات
- URLs = أسماء، لا أفعال:
/api/skills، لا /api/getSkills.
- طرق HTTP للأفعال: GET وPOST وPATCH وDELETE.
- جمع للمجموعات، مفرد للمصادر الفرعية:
/api/skills/42/resources.
- أخطاء متسقة:
{ "error": "validation", "fields": { … } }.
- تصفّح بالمؤشّرات (
?cursor=…&limit=20) أو بالإزاحات (?page=2).
- إصدارات في URL أو في ترويسة:
/v1/skills، Accept-Version: 1.
مثال أدنى
GET /v1/skills?roadmap=frontend → 200، قائمة
POST /v1/skills → 201، أُنشئ
PATCH /v1/skills/42 → 200، حُدِّث
DELETE /v1/skills/42 → 204، بلا محتوى