محمود الحبشمتاح لمشاريع جديدة
  • أعماليأعمالي
  • الخدماتالخدمات
  • المختبرالمختبر
  • المقالاتالمقالات
  • تواصلتواصل
عمّان--:--EN
المقالات/DevOps والسحابة

أفضل ممارسات تصميم REST API: ابنِ واجهات يحبها المطورون

صمم REST API نظيفة — طرق HTTP المناسبة وأكواد الحالة والترقيم والإصدارات ومعالجة الأخطاء.

22 فبراير 2026دقيقة قراءةDevOps والسحابةRead in English

في هذه الصفحة

  1. تسمية الموارد
  2. أكواد الحالة
  3. استجابة خطأ متسقة
  4. ترقيم بالمؤشر

API المصممة جيدًا تفرق بين تبني المطورين لخدمتك بحماس أو التخلي عنها.

تسمية الموارد

✓ GET /api/users
✓ GET /api/users/42
✓ POST /api/users
✗ GET /api/getUsers
✗ POST /api/createUser

أكواد الحالة

200 — GET/PUT ناجح
201 — POST ناجح
204 — DELETE ناجح
400 — أخطاء التحقق
401 — مصادقة مفقودة
404 — غير موجود
422 — أخطاء دلالية
429 — تجاوز حد المعدل

استجابة خطأ متسقة

json
{
    "error": {
        "code": "VALIDATION_ERROR",
        "message": "البيانات غير صالحة.",
        "details": [{"field": "email", "message": "مُستخدم بالفعل"}]
    }
}

ترقيم بالمؤشر

GET /api/posts?cursor=eyJpZCI6MTB9&per_page=20

اتبع هذه الأنماط بشكل متسق ووثّق بـ OpenAPI/Swagger.

كل المقالات

تابع القراءة

  • Docker للمطورين: من الصفر إلى التطبيقات المعبأة في حاويات28 فبراير 2026دقيقة قراءة
  • خطوط أنابيب CI/CD مع GitHub Actions: أتمتة كل شيء22 فبراير 2026دقيقة قراءة
  • مبادئ الكود النظيف: اكتب كودًا يمكن للبشر قراءته22 فبراير 2026دقيقة قراءة