Swagger هي أداة خاصة تقوم تلقائيًا بتكوين وثيقة RESTful API .
تكمن ميزته في حقيقة أنه لا يسمح لك فقط بالاطلاع على جميع نقاط النهاية الخاصة بالتطبيق ، ولكن أيضًا اختبارها على الفور أثناء العمل عن طريق إرسال طلب وتلقي رد.
للوصول إلى Swagger ، تحتاج إلى الضغط على زر Preview في التطبيق المنشور والنقر فوق اسم خطة النشر المطلوبة ( Deploy Plan ).
في النافذة المفتوحة حديثًا ، يتم عرض قائمة بنقاط النهاية المتاحة والأساليب المرتبطة بنقاط النهاية هذه. تتوفر بعض الطلبات فقط لمجموعات معينة من المستخدمين المصرح لهم (راجع البرامج Middleware Auth module لكل طلب محدد في قسم Endpoints ). Bearer Token مطلوب للطلبات المسموح بها للمستخدمين المصرح لهم فقط.
يمكنك الوصول إلى نقطة النهاية المقابلة مباشرة في Swagger للحصول على هذا الرمز المميز (قسم Auth ، POST /auth ).
اضغط Try it out وأدخل تسجيل الدخول وكلمة المرور للحصول على رمز مميز.
سيتم إرسال الطلب عند Execute . إذا تم بنجاح ، فسترى حقلاً token بقيمة Bearer token .
الطريقة الثانية للحصول على رمز مستخدم مصرح به هي أنه يمكن العثور على الرمز المميز في نص الطلب للتطبيق المنشور.
- اضغط على F12 في متصفح الويب الخاص بك لفتح أداة المطور.
- أرسل أي طلب في التطبيق المنشور (لتحديث الجداول ، على سبيل المثال). يجب أن يكون المستخدم الذي يرسل هذا الطلب مفوضًا للوصول إلى نقطة النهاية هذه.
- افتح علامة تبويب Network وابحث عن الطلب المقابل.
- انتقل إلى علامة التبويب " Headers " وابحث عن قسم " Request Headers ". سيتم تقديم Bearer token تحت Authorization .
قم بتوفير Bearer token لـ Swagger بالضغط على " Authorize " ولصق القيمة التي نسختها في الخطوة السابقة.
بالنسبة لطلبات الاختبار ، حدد المجموعة المرغوبة والطريقة التي تريد تنفيذها. اضغط Try it out واملأ معاملات إدخال الطلب. انقر فوق Execute لتنفيذ الاستجابة.
الاستجابة الأكثر توقعًا ، إذا تمت معالجة الطلب بشكل صحيح بواسطة الخادم ، لها الرمز 200 وتوضح الشكل الذي يجب أن تبدو عليه بنية الاستجابة.
401 - لم يتم إكمال الطلب بنجاح لأن رمز التفويض المطلوب مفقود أو غير صالح.
404 - تمت معالجة الطلب بنجاح ، ولكن لم يتم العثور على المورد المطلوب.
422 - تم تمرير معلمات غير صحيحة إلى إدخال الطلب.
500 - خطأ في معالجة الطلب من قبل الخادم.
رفع خطأ مخصص
بالنسبة إلى عمليات BP المخصصة والطلبات ذات الصلة ، من الممكن إنشاء رموز خطأ مخصصة مع الأوصاف باستخدام كتلة Raise Error في محرر BP. مثال على هذه العملية أدناه:
في هذه الحالة ، إذا فشل الطلب إلى نقطة النهاية المرتبطة بـ BP أعلاه ، فسيصدر الخادم خطأ 418 يحتوي على نص الخطأ عند تنفيذ قاعدة البيانات DB: Create Candidate block . يمكن أن يكون رمز الخطأ في هذا المثال أي رمز يحدده المستخدم.
ملاحظة: يشير رمز الاستجابة لخطأ عميل إبريق الشاي HTTP 418 إلى أن الخادم يرفض تحضير القهوة لأنه ، بشكل دائم ، إبريق شاي. بدلاً من ذلك ، يجب أن تُرجع إناء القهوة / الشاي المدمج الذي نفد مؤقتًا من القهوة 503. هذا الخطأ هو إشارة إلى Hyper Text Coffee Pot Control Protocol المحدد في نكات كذبة أبريل في عامي 1998 و 2014.
