يجب إتقان نقاط المعرفة الأساسية هذه في الاتصالات الأمامية والخلفية!

ما هو مريح؟

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

البروتوكول

استخدامه عند التواصل مع الواجهة الخلفية -end الخدمة من خلال واجهة برمجة التطبيقات (API)

اسم مجال

تحت اسم مجال مخصص ويجب أن تظل بسيطة قدر الإمكان. إذا كنت متأكدًا من أن واجهة برمجة التطبيقات (API) بسيطة جدًا ولن يتم توسيعها بشكل أكبر، فيمكنك التفكير في وضعها تحت اسم النطاق الرئيسي، فيما يلي مثالين شائعين لجذر عنوان URL:

• api.example.com/* يتم استخدام اسم نطاق فرعي منفصل الوصول إلى الواجهة
• example.com/api /* يجب أن تظل جميع واجهات برمجة التطبيقات في

إصدار مساحة واحدة (الإصدار)

متوافقة مع الإصدارات السابقة. يجب عليك تقديم إصدارات جديدة من واجهات برمجة التطبيقات مع ضمان أن الإصدار القديم من واجهات برمجة التطبيقات لا يزال متاحًا. لذلك، يجب توفير عنوان دعم الإصدار

(المسار) لعنوان URL المحدد لواجهة برمجة تطبيقات التوجيه (جهاز التوجيه)

ويجب

• أن تكون تسمية عنوان URL بأحرف صغيرة
• . يجب أن تكون تسمية المورد (المورد) في عنوان URL اسمًا. ويجب أن تكون بصيغة الجمع.
• يجب استخدام عناوين URL من النوع المريح أولاً
• . ويجب أن يكون عنوان URL سهل القراءة
• ويجب ألا يكشف عن بنية الخادم.

أما فيما يتعلق بما إذا كان عنوان URL يجب أن يستخدم الواصلات (-) أو الشرطة السفلية (_)، لا توجد قاعدة صارمة وسريعة، ولكن يجب أن تكون متسقة مع أسلوب يعتمد على موقف الفريق

• https://api.example.com/zoos
• https://api.example.com/animals
• https://api.example .com/zoos/{zoo}/animals
• https://api.example.com/animal_types
• https://api.example.com/employees

الفعل (طريقة طريقة الطلب)

هو نوع عملية محدد للموارد، ممثلة بأفعال HTTP . هناك خمسة أفعال HTTP شائعة الاستخدام (أوامر SQL المقابلة موجودة بين قوسين).

• الحصول على (SELECT): استرداد الموارد (عنصر واحد أو أكثر) من الخادم.
• POST (إنشاء): إنشاء مورد جديد على الخادم.
• PUT (تحديث): تحديث المورد على الخادم (يوفر العميل المورد الكامل بعد التغيير).
• التصحيح (تحديث): التحديث في جزء مورد تحديث الخادم (يوفر العميل سمات تم تغييرها).
• حذف (حذف): حذف الموارد من الخادم.

معلمات URL

يجب أن تكون جميع معلمات URL بأحرف صغيرة ويجب أن تستخدم نموذج معلمة نوع الشرطة السفلية. يجب أن تكون معلمات الترحيل ثابتة على الصفحة ويجب

الاستجابة (الاستجابة)

رمز حالة HTTP المناسب.
يجب إرجاع البيانات بتنسيق JSON.
يجب تنسيق كافة الأخطاء بشكل موحد.

رمز الحالة المشترك

• 1xx يعني أنه تم قبول الطلب ويحتاج إلى متابعة المعالجة.
• لا يظهر 2xx بشكل عام في واجهة برمجة التطبيقات (API) وقد تم إرجاع رأس الاستجابة أو نص البيانات المتوقع بواسطة الطلب مع هذه الاستجابة
  • 200. قام الخادم بإرجاع البيانات التي طلبها المستخدم بنجاح
  • 201 قام المستخدم بإنشاء بيانات جديدة أو تعديلها بنجاح
  • 202 يعني أن الطلب قد دخل إلى قائمة انتظار الخلفية (لا توجد قيمة إرجاع إذا نجحت، فهي غير متزامنة)
  • 204 تم الحذف بنجاح
• 3xx. إعادة توجيه
• 4xx خطأ ناتج عن أسباب العميل
  • 404 الواجهة المطلوبة غير موجودة، نوع الخطأ (عنوان الطلب خاطئ)
  • 401 لم
  • يتم تسجيل دخول المستخدم 403 تم تسجيل دخول المستخدم، ولكن ليس لديه إذن للوصول
  • 422 خطأ في معلمة العميل، خطأ في التحقق
  • 429 تجاوز حد الطلب
• 5xx خطأ ناتج عن أسباب من جانب الخادم
  • 500 واجه الخادم موقفًا غير متوقع، مما تسبب في عدم قدرته على إكمال معالجة الطلب، أبلغ رمز الخادم عن
  • خطأ 503. الخادم قيد الصيانة
  • 504 مهلة

تنسيق خطأ

• • الاستدعاء

'message' => ':message', // وصف تفصيلي للخطأ 'errors' => ':errors', // وصف تفصيلي للخطأ للمعلمات، 422 والحالات الأخرى توفر 'code' => ' :code', // رمز الاستثناء المحدد للأعمال 'status_code' => ':status_code'، // رمز حالة http 'debug' => ':debug'، // معلومات التصحيح، توفر البيئة غير الإنتاجية

ما هي الرسالة ؟

تُستخدم رسائل HTTP لتبادل المعلومات عند طلبات واستجابات HTTP.

تنقسم

الرسائل التي تتدفق إلى الخادم من العميل

ورسائل الاستجابة. إن بنيات الرسائل الأساسية لرسائل الطلب والاستجابة هي نفسها، وتتكون من ثلاثة أجزاء:

• سطر البداية: إجراء المعالجة على الخادم.
رأس
• وصف الرسالة
• : بعض السمات
• الجسم: البيانات [اختياري]
يقوم

axios

وخادم العقدة بإنشاء طلبات XMLHttpRequests من المتصفح
إنشاء طلبات http من Node.js

يدعم Promise API
يدعم اعتراض الطلبات والاستجابات، وتحويل بيانات الطلب وبيانات الاستجابة، وإلغاء الطلبات، والتحويل التلقائي لـ JSON، ودعم عميل البيانات للدفاع ضد XSRF

، هيا أيها الغرباء (أنا لست غريبًا على القدوم والذهاب، آمل ذلك سوف تكون مفيدة لك)

ما ورد أعلاه هو نقاط المعرفة الأساسية هذه، والتي يجب إتقانها في الاتصالات الأمامية والخلفية! لمزيد من التفاصيل، يرجى الانتباه إلى المقالات الأخرى ذات الصلة على موقع php الصيني!