تنفيذ واجهة برمجة تطبيقات مخصصة لخدمة REST للواجهة

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

من أفضل الممارسات البدء في إنشاء طبقة واجهة برمجة تطبيقات بين خدمات الواجهة الخلفية الخارجية وواجهة المستخدم لتقليل عدد المكالمات إلى خدمات الواجهة الخلفية كلما أمكن ذلك. على سبيل المثال، يمكن لتطبيق الأجهزة المتنقلة الخاص بك تنفيذ استدعاء واحد لطبقة واجهة برمجة التطبيقات (API) التي تعالج الاستدعاءات إلى خدمات REST الأخرى، وتدمج كل البيانات الواردة في استجابة واحدة لتطبيق الأجهزة المتنقلة الخاص بك.

تكوين API مخصص كامل

لتكوين واجهة برمجة تطبيقات مخصصة كاملة باستخدام Oracle Mobile Hub.

انقر على وحدد تطوير، ثم واجهات برمجة التطبيقات من القائمة الجانبية. إذا تم تكوين واجهة برمجة تطبيقات بالفعل (سواء في حالة مسودة أو منشور)، فسترى قائمة بواجهات برمجة التطبيقات. في حالة عدم وجود واجهات برمجة تطبيقات مخصصة، سترى صفحة تحتوي على زر واجهة برمجة تطبيقات جديدة. انقر على واجهة برمجة التطبيقات التي قمت بتكوينها بالفعل، أو انقر على واجهة برمجة تطبيقات جديدة للبدء.

تحديد نقاط الانتهاء

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

انقر على ارتباط التنقل نقاط الانتهاء للبدء.
انقر على مورد جديد، وأضف بعض المعلومات الأساسية.

في كل مرة تنقر فيها على مورد جديد، تقوم بتكوين مورد (جذر) عالي المستوى. إذا أردت إضافة مورد فرعي (متداخل)، فانقر على إضافة (+) بجوار مورد المستوى الأعلى. انقر على X لحذف مورد.

ملاحظة:
هل ترى الأيقونات ضمن ارتباطات الأساليب؟ في كل مرة تقوم فيها بتعريف أسلوب لمورد، تظهر أيقونة خاصة به ضمن ارتباط الأساليب. استخدمها كاختصارات لمعرفة الأساليب التي تم تعريفها بالفعل لمورد. انقر على أيقونة للانتقال مباشرة إلى تعريفها في صفحة "الأساليب".
توفير مسار المورد، وهو معرف URI (نسبة إلى معرف URI الأساسي). على سبيل المثال، إذا كان معرف URI الأساسي هو /mobile/custom/audits/، فيمكنك إضافة المورد findings، وهو /mobile/custom/audits/findings.
توفير اسم العرض، وهو اسم للمورد يسهل تعريفه في وثائق API.
يتم سرد الموارد بأسماء العرض الخاصة بها على الجانب الأيسر من صفحة اختبار واجهة برمجة التطبيقات.
توفير وصف مختصر للمورد.

بعد إدخال وصف، يتم عرض معرف URI أسفل حقل الوصف.
(اختياري) أدخل نوع مورد RAML، وهو نوع المورد (resourcesType:). لست بحاجة إلى تحديد نوع مورد. إذا أردت استخدام نوع مورد ولكن لم يتم تحديد نوع مورد، فانقر على ارتباط الأنواع وحدد نوع مورد.

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

يمكنك مسح الفوضى لتحديد موقع المورد بسرعة أكبر من خلال التبديل إلى الوضع المضغوط (على يمين مورد جديد). تخفي الشاشة المدمجة وصف المورد ونوع المورد والمسار.

إضافة أساليب إلى مواردك

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

أضف بعض الأساليب إلى المورد بالنقر على الأساليب.

إذا كان المورد الذي تقوم بتعريف طرق له معلمات مسار، فسيتم عرضه أعلى إضافة أسلوب.
1. (اختياري) انقر على مطلوب إذا أردت تمرير معلمات المسار مع كل أسلوب.
  يتم عرض اسم المعلمة.
2. توفير اسم عرض للمعلمة ومثال على التعليمة البرمجية.
3. من القائمة المنسدلة، حدد نوع القيمة الصالح للمعلمة.
انقر على إضافة أسلوب، وحدد الأسلوب الذي تريده.

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

إذا لم يكن لديك أية سمات موارد محددة، فانقر على نقاط الانتهاء للعودة إلى صفحة الموارد الرئيسية، وانقر على ارتباط السمات لتحديد واحدة. تتيح لك السمات تحديد مجموعة من العمليات المماثلة.

بعد تعريف أساليب المورد، يمكنك تعريف الطلبات والاستجابات لهذه الأساليب.

تعريف طلب للأسلوب

بعد تحديد أسلوب، حدد الطلب الذي تقوم به من الخدمة التي تريد الاتصال بها. على سبيل المثال، إذا قمت بتحديد أسلوب POST، فيمكنك الآن تعريف ما تريد تكوينه. يمكنك القيام بذلك عن طريق إضافة معلمات ونص طلب، والذي يحتوي على وصف البيانات المطلوب إرسالها إلى الخدمة.

انقر على طلب لتحديد طلب.
انقر على إضافة معلمة وحدد نوع المعلمة: استعلام أو رأس. حدد مطلوب إذا كانت المعلمة مطلوبة للأسلوب.
1. امنح المعلمة اسمًا واسم عرض.
2. حدد نوع قيمة صالحًا: سلسلة أو رقم أو عدد صحيح أو تاريخ أو منطقي.
3. (اختياري) أدخل وصفًا للمعلمة ومثالًا يمكنك استخدامه عند اختبار صلاحية نقطة الانتهاء. على سبيل المثال، يمكنك الحصول على مورد، audits، وإضافة معلمة استعلام، auditorID، تشتمل على قيمة رقمية ومعلمة أخرى، auditName، تشتمل على قيمة سلسلة:
```
/audits: 
  get: 
    description: | 
      Gets list of audits, organizations etc.     
    queryParameters: 
      auditorID:  
        id: Auditor ID
        description: | 
          display auditor identifier 
        type: integer 
        example: |
          1234
        required: false      
      auditName:
        displayName: auditName
        description: |
          Audit name
        example: "Payroll Process Audit"
```
  في هذا المثال، يتم تعريف أسلوب GET بمعلمات الاستعلام auditorID وauditName.
4. (اختياري) انقر على مزيد من الخصائص لإضافة خصائص متداخلة إلى المعلمة. انقر على تكرار لإضافة مضاعفات المعلمة الحالية.
5. انقر على إضافة معلمة لإضافة معلمة مستوى علوي أخرى للأسلوب.
اعتمادًا على الأسلوب الذي حددته، انقر على إضافة نوع وسائط وحدد نص الأسلوب. يحتوي النص على البيانات التي تقوم بإرسالها إلى الخادم. على سبيل المثال، إذا كنت تقوم بتحديد طريقة POST، فستحتاج إلى تحديد الصنف الذي تقوم بتكوينه، مثل قائمة عملاء جديدة أو طلب خدمة. إذا كنت تقوم بتعريف أسلوب GET، فلن تحتاج إلى إرسال نص أسلوب حتى لا تحتاج إلى تحديد نوع وسائط.
1. حدد نوع الوسائط لنص الأسلوب، وهو تنسيق الرسالة التي ترسلها، مثل النصوص أو الصور أو نماذج الويب.
  تبعًا للنوع (على سبيل المثال، لن تقوم بإدخال مخطط لنوع صورة)، يتوفر لديك خيار إضافة مخطط أو مثال أو كليهما.
  عند تحديد مخطط، قم بإضافة البيانات اللازمة فقط لغرض المورد. وهذا يعني، لا تضيف بيانات غير ضرورية من شأنها فقط إبطاء الإرسال وربما زيادة احتمال حدوث أخطاء.
2. (اختياري) انقر على مخطط، وأدخل مخطط قاعدة بيانات (بتنسيق JSON) في جزء المحرر. المخطط يشبه قالب النص. وهو ما تستخدمه في تعريف محتويات الرسالة.
3. (اختياري) انقر على مثال، وأدخل مثالاً (بتنسيق JSON) في جزء المحرر، والذي يتم استخدامه بواسطة التنفيذ الوهمي كاستجابة وهمية للأسلوب. يمكن أن يساعدك استخدام البيانات الوهمية في التحقق من سلوك أساليبك. يعرض المثال القيم الوهمية للبيانات التي يتم إرسالها في نص الرسالة كما هو معرف في أسلوب POST لمورد audits:
```
body: 
  application/json: 
    example: | 
      { 
        "Title": "Leaking Water Heater",
        "Username": "joh1017",  
        "imageLink": "storage/collections/2e029813-d1a9-4957-a69a-fbd0d7431d77/objects/6cdaa3a8-097e-49f7-9bd2-88966c45668f?user=lynn1014", 
        "Notes": "my water heater is broken"
      }                               
```
انقر على إضافة نوع وسائط لإضافة أنواع وسائط إضافية. إذا قررت أنك لا تريد الأسلوب، فانقر على X في الترويسة لحذفه.

تحديد استجابة للطريقة

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

انقر الاستجابة لتحديد استجابة واحدة أو أكثر.
انقر على إضافة استجابة، وحدد رمز الحالة الذي تريد إرجاعه.
يتم توفير رمز الحالة 200 بشكل افتراضي ولكن إذا لم يكن هذا هو الرمز الذي تريده، فحدد رمزًا من القائمة المنسدلة.
- يشير 2xx إلى نجاح الاتصال.
- يشير 3xx إلى حدوث إعادة توجيه.
- يشير 4xx إلى حدوث خطأ في المستخدم.
- يشير 5xx إلى حدوث خطأ في الخادم.
لمساعدة أي شخص يستخدم واجهة برمجة التطبيقات (API) لفهم سبب حدوث خطأ محتمل في واجهة برمجة التطبيقات (API) التي تقوم بتكوينها، استخدم رمز حالة HTTP لإرجاع تعليمات برمجية تتطابق بشكل أفضل مع موقف الخطأ.
تقديم وصف لما يحدده الرمز.
انقر على إضافة رأس، وحدد عنوان استجابة أو استعلام، ثم أدخل اسم الرأس أو الاستعلام واسم العرض للرأس ونوع القيمة الصالحة للرأس.
انقر على إضافة نوع وسائط، وحدد صيغة الاستجابة. تبعًا لنوع الوسائط الذي تحدده، يمكنك إضافة معلمات أو مخططات أو أمثلة كما فعلت مع نص الطلب.
1. بالنسبة لنوع الوسائط المستند إلى نص (على سبيل المثال، application/json أو text/xml)، انقر على مخطط لإدخال مخطط (بتنسيق JSON) للنص.
  كما هو الحال مع نص الطلب، قم بإضافة البيانات ذات الصلة فقط إلى نص الاستجابة. لا تقم بتضمين بيانات أكثر مما تحتاجه بالفعل للعملية.
2. انقر على مثال لإضافة بيانات وهمية (بتنسيق JSON) لنص الاستجابة. استخدم البيانات الوهمية للتحقق من سلوك أساليبك قبل الاختبار باستخدام بيانات حقيقية.
3. بالنسبة لنوع الوسائط المستند إلى نموذج (على سبيل المثال، multipart/form-data)، انقر على إضافة معلمة وحدد مطلوب إذا كانت المعلمة إلزامية. ثم أدخل اسمًا وحدد نوع قيمة. اختياريًا، يمكنك منح المعلمة اسمًا.
4. بالنسبة لنوع الوسائط المستند إلى الصور (على سبيل المثال، image/png)، لا يتعين عليك فعل أي شيء لعدم وجود مخططات أو سمات لتقديمها.

يوضح المثال التالي أنه تم تكوين استجابة لأسلوب POST الخاص بمورد audits برمز حالة 201 يشير إلى تكوين مورد جديد بنجاح. كما يعرض المثال صيغة رد الإرجاع وهي application/json ورأس Location الذي تمت إضافته ونص الرسالة الذي يحتوي على بيانات وهمية:

responses: 
  201: 
    description: | 
      The request has been fulfilled and resulted in a new resource 
      being created. The newly created resource can be referenced  
      by the URI(s)returned in the entity of the response, with the 
      most specific URI for the resource given by a Location header
      field.  

    headers:
      Location:
        displayName: Location
        description: |
          Identifies the location of the newly created resource.

        type: string
        example: |
          /20934

        required: true

    body: 
      application/json: 
        example: | 
          {
            "id": 20934,
            "title": "Lynn's Leaking Water Heater",
            "contact": {
               "name": "Lynn Adams",                 
               "street": "45 O'Connor Street",
               "city": "Ottawa", 
               "postalcode": "a1a1a1",
               "username": "johnbeta"
              },
           "status": "New",
           "driveTime": 30,
           "priority": "high",
           "notes": "My notes",
           "createdon": "2014-01-20 23:15:03 EDT",
           "imageLink": "storage/collections/2e029813-d1a9-4957-a69a-fbd0d74331d77/objects/6cdaa3a8-097e-49f7--9bd2-88966c45668f?user=lynn1014"
          }

عند تعريف الاستجابة الخاصة بك، يمكنك اختيار اختبار نقاط الانتهاء أو النقر على نقاط الانتهاء في شريط الاستكشاف للرجوع إلى صفحة الموارد الرئيسية. من هناك، يمكنك المتابعة إلى صفحة أخرى في مصمم واجهة برمجة التطبيقات لتكوين جذر أو أنواع موارد أو سمات أو إضافة وثائق واجهة برمجة التطبيقات.

إذا قررت أنك لا تريد الأسلوب، فانقر على X في الترويسة لحذفه.

تكوين واجهة API لموصل REST

استخدم معالج واجهة API لموصل REST لتكوين واجهة API للموصل وتكوينها واختبارها.

للحصول على واجهة API لموصل العمل الأساسي، يمكنك توفير اسم لواجهة API للموصل وعنوان URL للخدمة الخارجية.

من هناك، يمكنك:

حدد قواعد لتكوين طلبات أو استجابات محددة للبيانات التي تريد الوصول إليها.
تكوين نُهج أمان من جانب العميل للخدمة التي تقوم بالوصول إليها.
اختبر الاتصال واختبر نتائج المكالمات التي تم إجراؤها على الاتصال.

يجب تكوين واجهة برمجة تطبيقات وتنفيذ مخصصة لتمكين تطبيقاتك من استدعاء واجهات برمجة تطبيقات الموصل وإنشاء واجهة برمجة التطبيقات والتنفيذ تلقائيًا. إذا كنت تريد القيام بذلك يدويًا، فيجب إنشاء واجهة برمجة تطبيقات مخصصة بالموارد المناسبة، ثم تنفيذ الرمز المخصص.

إعداد موصل أساسي

يمكنك تكوين موصل فعال عن طريق إكمال الصفحتين الأوليين في معالج الواجهة البرمجية للتطبيق لموصل REST.

انقر على وحدد تطوير، ثم واجهات برمجة التطبيقات من القائمة الجانبية.
انقر على REST (إذا كان هذا أول واجهة API للموصل يتم تكوينها) أو موصل جديد ومن القائمة المنسدلة، حدد REST.
حدد الواجهة البرمجية للتطبيق لموصل REST الجديد من خلال توفير ما يلي:
1. اسم عرض واجهة برمجة التطبيقات: الاسم كما سيظهر في قائمة واجهات برمجة تطبيقات الموصل.
2. اسم واجهة برمجة التطبيقات: الاسم الفريد لواجهة برمجة تطبيقات الموصل.
  
  افتراضيًا، يتم إلحاق هذا الاسم بمعرف URI الأساسي النسبي كاسم المورد لواجهة API للموصل. يمكنك رؤية معرف URI الأساسي أسفل حقل اسم واجهة برمجة التطبيقات.
  
  بخلاف إصدار جديد من واجهة API للموصل هذا، لا يمكن أن يكون لواجهة API للموصل الآخر نفس اسم المورد.
3. الوصف القصير: سيتم عرض هذا الوصف في صفحة الموصلات عند تحديد API هذا.
انقر على تكوين.
في الصفحة "عام" بمربع الحوار "واجهة برمجة تطبيقات موصل REST"، قم بتعيين قيم انتهاء الوقت:
- انتهاء وقت قراءة HTTP: الحد الأقصى للوقت (بالمللي ثانية) الذي يمكن إنفاقه في انتظار قراءة البيانات. في حالة عدم إدخال قيمة، يتم تطبيق القيمة الافتراضية 20 ثانية.
- انتهاء وقت اتصال HTTP: الوقت (بالمللي ثانية) المستغرق في الاتصال بعنوان URL البعيد. تعني القيمة 0 مللي ثانية أنه مسموح بانتهاء الوقت اللانهائي.
  
  يجب أن تكون قيم انتهاء وقت HTTP أقل من سياسة Network_HttpRequestTimeout، والتي تشتمل على قيمة افتراضية تبلغ 40000 مللي ثانية.
  
  ملاحظة:
  إذا كان لديك دور مسئول سحابة متنقلة بالإضافة إلى دور مطور الخدمة، فيمكنك فتح ملف policies.properties للاطلاع على قيمة سياسات الشبكة للبيئة الحالية من خلال طريقة عرض "المسئول". وإلا، فاطلب من مسئول سحابة الأجهزة المتنقلة معرفة القيم.
انقر على الواصف، وأدخل معلومات الاتصال الخاصة بالخدمة.

إذا قمت بإدخال عنوان URL لواصف Swagger، فسيتم تعريف الموارد المتاحة وعرضها، ويمكنك تحديد الموارد التي تريدها.

ملاحظة:
يتم دعم منافذ الوصول القياسية إلى الإنترنت 80 و443 فقط. لا يمكن إجراء اتصال بخدمة باستخدام منفذ مخصص.
انقر على حفظ.
(اختياري) انقر على اختبار، وحدد بيانات صلاحية التصديق، وقم بإجراء استدعاءات اختبار للخدمة.

من هناك، يمكنك تكوين الموصل بالطرق التالية:

(إذا قمت بإدخال واصف في صفحة الواصف) انتقل إلى صفحة الموارد، وحدد أساليب الموارد المعروضة.
تعريف القواعد.
تعيين سياسات التأمين.

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

تعيين القواعد

يمكنك تعيين القواعد لتحديد التفاعلات بين تطبيق الأجهزة المتنقلة والخدمة. توفر لك القواعد طريقة لإضافة قيم معلمات افتراضية لجميع الاستدعاءات إلى الموارد الموجودة في الخدمة، والاستدعاءات إلى مسار وكيل محدد، والاستدعاءات لأنواع معينة من العمليات (verbs). يساعد ذلك على فرض صياغة متسقة لسلسلة عنوان URL، ويحفظ مطور التعليمات البرمجية المخصص من الاضطرار إلى إدراج هذه القيم، ويجعل من الممكن تتبع المكالمات المختلفة من خلال التحليلات.

يمكنك تكوين قاعدة واحدة أو أكثر. يمكن أن تشتمل كل قاعدة على معلمة واحدة أو أكثر من النوعين Query وHeader.

في حالة عدم تطبيق أية قواعد، يتم تمرير كل الاستدعاءات عبر البروكسي إلى الخدمة الموجودة.

إذا لم يكن الموصل مفتوحًا بالفعل، فانقر على وحدد Development ثم APIs من القائمة الجانبية.
حدد واجهة API للموصل التي تريد تحريرها وانقر على فتح.
حدد الأدوار.
انقر على قاعدة جديدة.
انقر على إضافة معلمة، وحدد نوع معلمة استعلام أو عنوان وأدخل اسم الاستعلام أو الرأس وقيمته.

ملاحظة:

على الرغم من أنه يمكنك تعريف قواعد لتعيين رؤوس معينة بشكل افتراضي، إلا أنه لا يتم تطبيق القواعد إذا قام العميل الذي قام باستدعاء الموصل مباشرة من خلال تعليمات برمجية مخصصة أو بشكل غير مباشر، مثل مستعرض ويب أو تطبيق هاتف محمول، بتعيين نفس الرؤوس بالفعل.

على وجه الخصوص، يتم تعيين تنسيق نص الطلب عادةً في التعليمات البرمجية المخصصة برأس Content-Type، وليس كقاعدة موصل REST. وبالمثل، يتم أيضًا تعيين تنسيق نص الاستجابة في الرمز المخصص برأس Accept، وليس كقاعدة موصل REST.

يمكنك إضافة العديد من المعلمات إلى قاعدة كما تريد ولكن من الأفضل عدم التحميل الزائد لقاعدة ذات عمليات كثيرة للغاية. يسهل استكشاف أخطاء مكون القاعدة وإصلاحها.
قم بتوسيع الموارد وتحرير عنوان URL البعيد لتوفير مورد للقاعدة المطلوب تطبيقها عليها. قيمة عنوان URL الأساسية هي ما أدخلته في خطوة إعداد المعلومات الأساسية ولا يمكن تحريرها.
حدد عدم التطبيق على موارد المستوى الأدنى إذا كنت تريد تطبيق القواعد على مستوى المورد المحدد في عنوان URL البعيد فقط.
(اختياري) قم بإلغاء تحديد أساليب HTTP التي لا تريد تطبيقها على القواعد التي قمت بتعريفها للتو. بشكل افتراضي، يتم تحديد كل الأساليب.
(اختياري) انقر على قاعدة جديدة لتكوين قاعدة أخرى.

ملاحظة:

في حالة تعريف قاعدة تتعارض مع قاعدة أخرى، يكون للقاعدة الأولى المطبقة الأسبقية ويتم تجاهل القاعدة المتعارضة.

عند الانتهاء، انقر على حفظ ثم انقر على التالي (>) للانتقال إلى الخطوة التالية في تكوين واجهة برمجة تطبيقات الموصل.

يتم عرض وصف القاعدة التي قمت بتحديدها للتو في ترويسة القاعدة أعلى قسم المعلمات الافتراضية. على سبيل المثال، لنفترض أنه تم إدخال القيم التالية:

عنوان URL البعيد = https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle
URI المحلي = myMapAPI
قاعدة بالمعلمة التالية: Query:key:A3FAEAJ903022
أساليب GET وPUT HTTP

يصبح نص وصف القاعدة كما يلي:

بالنسبة إلى GET إلى https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle، يمكن الاطلاع على الموقع myMapAPI/directions، بما في ذلك Query:key=A3FAEAJ903022.

في حالة عدم تكوين قواعد، سيكون الوصف كما يلي:

بالنسبة لجميع الطرق إلى https://maps.googleapis.com/maps/api/directions المتاحة على myMapAPI، لن يتم تطبيق معلمات افتراضية.

لديك الآن معرف URI أساسي يربط الخدمة الحالية. باستخدام مثالنا:

mobile/connector/myMapAPI/directions/json?origin=los+angeles&destination=seattle الخرائط إلى https://maps.googleapis.com/maps/api/directions/json?origin=los+angeles&destination=seattle

تكوين سياسات التأمين وخصائص التجاوز

قبل الانتهاء من واجهة برمجة تطبيقات الموصل، يجب عليك التفكير في كيفية التعامل مع أمانها. يمكنك استخدام إما سياسات التأمين أو رؤوس الاعتماد. إن تحديد نظام تأمين يصف مخطط التصديق الخاص بالخدمة التي تتصل بها هو الأسلوب الموصى به.

يحتوي كل نهج أمان على خصائص، تسمى التجاوزات، يمكنك تكوينها. أحد أسباب تجاوز خاصية تكوين السياسة هو الحد من عدد السياسات التي يتعين عليك صيانتها: بدلاً من إنشاء سياسات متعددة بتكوينات متنوعة قليلاً، يمكنك استخدام نفس السياسة العامة وتجاوز قيم محددة لتلبية متطلباتك.

لتحديد نهج أمان وتعيين تجاوزات النهج:

إذا لم يكن الموصل مفتوحًا بالفعل، فانقر على وحدد Development، ثم APIs من القائمة الجانبية.
حدد واجهة API للموصل التي تريد تحريرها وانقر على فتح.
حدد التأمين.
حدد نهج الأمان من قائمة النُهج المتاحة وانقر على السهم الأيمن لنقله إلى قائمة الأنظمة المحددة.
حدد سياسة واحدة فقط لواجهة API للموصل. يظهر وصف النهج المحدد أسفل القائمة.
حدد التجاوزات، إن وجدت، للنظام المحدد إذا كنت لا تريد استخدام القيم الافتراضية.
لتجاوز خاصية، أدخل أو حدد قيمة غير القيمة الافتراضية.
انقر على حفظ لحفظ عملك أو حفظ وإغلاق لحفظ عملك والخروج من معالج الواجهة البرمجية للتطبيق لموصل REST.
انقر على التالي (>) للانتقال إلى الخطوة التالية.