قواعد ذهبية لتصميم واجهات API قابلة للتوسع وسهلة الاستخدام للمطورين.
واجهة API جيدة التصميم تسهّل على المطورين الاستخدام وتقلل الأخطاء.
الأسماء والمسارات
استخدم أسماء جمع (users وليس user)، وأفعال HTTP الصحيحة: GET للقراءة، POST للإنشاء، PUT/PATCH للتحديث، DELETE للحذف.
الترقيم والتصفية
قدم pagination وفلترة واضحة مثل ?page=2&per_page=20&status=active.
رموز الحالة والرسائل
استخدم 200، 201، 400، 404، 422 بشكل متسق مع رسائل خطأ مفهومة.
أضف تعليقك