#pkg: "@nocobase/plugin-data-source-rest-api"

#مصدر بيانات REST API

#مقدمة

تتيح لك هذه الإضافة دمج البيانات من مصادر REST API بسلاسة.

#التثبيت

بصفتها إضافة تجارية، تتطلب هذه الإضافة رفعها وتفعيلها عبر مدير الإضافات.

#إضافة مصدر REST API

بعد تفعيل الإضافة، يمكنك إضافة مصدر REST API باختياره من القائمة المنسدلة "إضافة جديد" في قسم إدارة مصادر البيانات.

قم بتكوين مصدر REST API.

#إضافة مجموعة

في NocoBase، يتم ربط مورد RESTful بمجموعة، مثل مورد المستخدمين (Users).

GET /users
POST /users
GET /users/1
PUT /users/1
DELETE /users/1

يتم ربط نقاط نهاية API هذه في NocoBase على النحو التالي:

GET /users:list
POST /users:create
POST /users:get?filterByTk=1
POST /users:update?filterByTk=1
POST /users:destroy?filterByTk=1

للحصول على دليل شامل حول مواصفات تصميم NocoBase API، يرجى الرجوع إلى وثائق API.

راجع فصل "NocoBase API - Core" للحصول على معلومات مفصلة.

يتضمن تكوين المجموعة (Collection) لمصدر بيانات REST API ما يلي:

#List (قائمة)

ربط الواجهة لعرض قائمة الموارد.

#Get (الحصول على)

ربط الواجهة لعرض تفاصيل المورد.

#Create (إنشاء)

ربط الواجهة لإنشاء مورد.

#Update (تحديث)

ربط الواجهة لتحديث مورد.

#Destroy (حذف)

ربط الواجهة لحذف مورد.

يجب تكوين واجهتي List و Get إلزامياً.

#تصحيح أخطاء API

#دمج معلمات الطلب

مثال: قم بتكوين معلمات الترحيل (pagination) لواجهة List. إذا كانت واجهة برمجة التطبيقات (API) للطرف الثالث لا تدعم الترحيل بشكل أساسي، فستقوم NocoBase بالترحيل بناءً على بيانات القائمة المسترجعة.

يرجى ملاحظة أن المتغيرات المضافة في الواجهة فقط هي التي ستصبح سارية المفعول.

يمكنك النقر على "Try it out" لتصحيح الأخطاء وعرض الاستجابة.

#تحويل تنسيق الاستجابة

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

اضبط قواعد التحويل بناءً على تنسيق استجابة API للطرف الثالث لضمان توافق المخرجات مع معيار NocoBase.

وصف عملية تصحيح الأخطاء

#المتغيرات

يدعم مصدر بيانات REST API ثلاثة أنواع من المتغيرات لدمج API:

• متغيرات مصدر البيانات المخصصة
• متغيرات طلب NocoBase
• متغيرات استجابة الطرف الثالث

#متغيرات مصدر البيانات المخصصة

#طلب NocoBase

• Params: معلمات استعلام URL (Search Params)، والتي تختلف حسب الواجهة.
• Headers: رؤوس الطلب المخصصة، والتي توفر بشكل أساسي معلومات X- محددة من NocoBase.
• Body: نص الطلب.
• Token: رمز API الخاص بطلب NocoBase الحالي.

#استجابات الطرف الثالث

حاليًا، يتوفر فقط نص الاستجابة (response body).

فيما يلي المتغيرات المتاحة لكل واجهة:

#List (قائمة)

#Get (الحصول على)

#Create (إنشاء)

#Update (تحديث)

#Destroy (حذف)

#تكوين الحقول

يتم استخراج البيانات الوصفية للحقول (Fields) من بيانات واجهة CRUD للمورد المتكيف لتكون بمثابة حقول للمجموعة.

استخراج البيانات الوصفية للحقول.

الحقول والمعاينة.

تعديل الحقول (على غرار مصادر البيانات الأخرى).

#إضافة كتل مصدر بيانات REST API

بمجرد تكوين المجموعة، يمكنك إضافة كتل إلى الواجهة.