عند بناء REST API الهدف أن يفهم المطورون والعملاء (clients) واجهتك بسرعة دون توثيق ضخم فقط لقراءة المسارات.
الموارد (Resources)
استخدم أسماء جمع للموارد: /users، /posts. المعرف داخل المسار: /users/42.
الأفعال عبر HTTP
- GET: قراءة دون تغيير.
- POST: إنشاء مورد جديد ضمن مجموعة.
- PUT: استبدال المورد بالكامل.
- PATCH: تحديث جزئي.
- DELETE: حذف.
رموز الحالة
استخدم 201 عند الإنشاء، 204 عند نجاح بلا جسم، 400 طلب خاطئ، 401/403 للهوية والصلاحية، 404 غير موجود، 422 لأخطاء التحقق.
نمط الأخطاء
جسم JSON موحّد، مثلاً: message وerrors حقلي تفاصيل حسب الحاجة.