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

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

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

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

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

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

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

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

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

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

   ملاحظة:

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

   بعد إدخال وصف، يتم عرض معرف URI أسفل حقل الوصف.

6. (اختياري) قم بتوفير نوع مورد RAML، وهو نوع المورد (resourcesType:). لا يلزم تحديد نوع مورد. إذا كنت تريد استخدام نوع المورد ولكن لم يتم تحديد نوع مورد، انقر رابط الأنواع وحدد نوع.

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

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

إضافة طرق إلى الموارد

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

1. أضف بعض الطرق للمورد بنقر الطرق

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

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

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

3. (اختياري) أدخل وصفًا مختصرًا للأسلوب في حقل الوصف.
4. (اختياري) أدخل اسم عرض للأسلوب.
5. (اختياري) أدخل أية سمة لتطبيقها على الأسلوب.

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

بعد تحديد طرق للمورد، يمكنك تحديد الطلبات والردود لهذه الطرق.

تحديد طلب للطريقة

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

1. انقر طلب لتحديد طلب.
2. انقر على إضافة معلمة وحدد نوع معلمة: استعلام أو رأس. حدد مطلوب إذا كانت المعلمة مطلوبة للأسلوب.
   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. انقر على إضافة معلمة لإضافة معلمة مستوى علوي أخرى للأسلوب.
3. تبعًا للأسلوب المحدد، انقر على إضافة نوع وسائط وحدد نص الأسلوب. يحتوي النص على البيانات التي تقوم بإرسالها إلى الخادم. على سبيل المثال، إذا كنت تقوم بتعريف أسلوب POST، فستحتاج إلى تعريف العنصر الذي تقوم بتكوينه، مثل قائمة عملاء جديدة أو طلب خدمة. إذا كنت تقوم بتحديد أسلوب GET، فلن تحتاج إلى إرسال نص أسلوب حتى لا تحتاج إلى تحديد نوع وسائط.
   1. اختر نوع الوسائط لنص الأسلوب، أي صيغة الرسالة التي تقوم بإرسالها، مثل النص أو الصور أو نماذج الويب.
      اعتمادًا على النوع (على سبيل المثال، قد لا تدخل مخطط قاعدة بيانات لنوع صورة)، لديك خيار إضافة مخطط قاعدة بيانات أو مثالاً على كليهما.

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

   2. (اختياري) انقر على مخطط قاعدة البيانات وأدخل مخطط قاعدة بيانات (بصيغة JSON) في جزء المحرر. يشبه مخطط قاعدة البيانات قالبًا للنص. وهو ما تستخدمه لتعريف محتويات الرسالة.
   3. (اختياري) انقر على مثال، وأدخل مثالاً (بصيغة JSON) في جزء المحرر، والذي تستخدمه عملية تنفيذ mock كاستجابة mock للأسلوب. يمكن أن يساعدك استخدام بيانات الرزمة على التحقق من سلوك الأساليب الخاصة بك. يعرض المثال قيم mock للبيانات التي يتم إرسالها في نص الرسالة كما هو معرف في أسلوب 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"
            }                               
      

4. انقر إضافة نوع وسائط لإضافة أنواع وسائط إضافية إذا قررت أنك لا ترغب في استخدام الأسلوب، فانقر على X في الترويسة لحذفه.

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

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

1. انقر على استجابة لتحديد استجابة واحدة أو أكثر.
2. انقر إضافة رد، ثم حدد رمز الموقف الذي تريد إرجاعه.

   يتم توفير رمز موقف 200 افتراضيًا، ولكن إذا لم يكن الرمز المطلوب، فحدد واحدًا من القائمة المنسدلة.

   • 2 xx يشير إلى نجاح اتصال.

   • 3 xx تشير إلى حدوث إعادة توجيه.

   • 4 xx تشير إلى حدوث خطأ مستخدم.

   • 5 xx تشير إلى حدوث خطأ في الخادم.

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

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

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

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 في الترويسة لحذفه.

تكوين واجهة برمجة تطبيقات REST Connector

استخدم معالج واجهة برمجة تطبيقات REST Connector لإنشاء واجهة API للموصل وتكوينها واختبارها.

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

ومن هذا الموضع، يمكنك:

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

• تكوين أنظمة تأمين جانب العميل للخدمة التي تحاول الوصول إليها.

• اختبار الاتصال واختبار نتائج المكالمات التي تم إجراؤها على الاتصال.

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

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

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

1. انقر على وحدد التطوير ثم واجهات api من القائمة الجانبية.

2. انقر على REST (إذا كانت واجهة API للموصل الأولى المطلوب تكوينها) أو موصل جديد ومن القائمة المنسدلة، حدد REST.

3. حدد واجهة API لموصل REST الجديد عبر توفير ما يلي:

   1. اسم عرض API: الاسم الذي سيظهر في قائمة واجهات API للموصل.

   2. اسم واجهة برمجة التطبيقات: الاسم الفريد لواجهة برمجة تطبيقات الموصل الخاصة بك.

      بشكل افتراضي، يتم إلحاق هذا الاسم بمعرف URI الأساسي النسبي كاسم مورد لواجهة API للموصل. يمكن رؤية معرف URI الأساسي أسفل حقل اسم API.

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

   3. الوصف المختصر: سيتم عرض هذا الوصف في صفحة "الموصلات" عند تحديد واجهة API هذه.

4. انقر على تكوين.

5. في الصفحة عام من مربع الحوار REST Connector API، قم بتعيين قيم انتهاء الوقت:

   • انتهاء وقت قراءة HTTP: الحد الأقصى للوقت (بالمللي ثانية) الذي يمكن إنفاقه في انتظار قراءة البيانات. إذا لم توفر قيمة، فسيتم تطبيق القيمة الافتراضية 20 ثانية.

   • انتهاء وقت اتصال HTTP: الوقت (بالمللي ثانية) المنقضي في الاتصال بعنوان URL البعيد. تعني القيمة 0 mms انتهاء وقت لا نهائي.

     يجب أن تكون قيم انتهاء وقت HTTP أقل من نظام Network_HttpRequestTimeout، والذي يشتمل على القيمة الافتراضية 40,000 مللي ثانية.

     ملاحظة:

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

6. انقر على الواصف، وأدخل معلومات الاتصال الخاصة بالخدمة.

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

   ملاحظة:

   لا يتم دعم سوى منافذ الوصول القياسية عبر الإنترنت 80 و443. لا يمكن الاتصال بخدمة باستخدام منفذ مخصص.

7. انقر على حفظ.

8. (اختياري) انقر على اختبار وحدد صلاحيات التصديق وقم بإجراء استدعاءات الاختبار للخدمة.

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

• (في حالة إدخال واصف في صفحة الواصف) انتقل إلى صفحة الموارد وحدد طرق الموارد المعروضة.

• تحديد القواعد.

• تعيين أنظمة التأمين.

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

إعداد القواعد

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

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

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

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

   ملاحظة:

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

   وبشكلٍ محدد، يتم تعيين صيغة نص الطلب عادةً في التعليمات البرمجية المخصصة بالرأس Content-Type، وليس كقاعدة REST Connector. وبالمثل، فإن تعيين صيغة نص الاستجابة يتم كذلك في التعليمات البرمجية المخصصة بالرأس Accept، وليس كقاعدة REST Connector.

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

6. قم بتوسيع الموارد وتحرير عنوان URL البعيد لتوفير مورد للقاعدة المطلوب التطبيق عليها. قيمة عنوان URL الأساسي هي ما قمت بإدخاله في خطوة إعداد المعلومات الأساسية ولا يمكن تحريرها.
7. حدد عدم التطبيق على موارد المستوى السفلي إذا كنت تريد تطبيق القواعد على مستوى المورد المحدد فقط في عنوان URL البعيد.
8. (اختياري) قم بإلغاء تحديد أساليب HTTP التي لا تريد تطبيقها على القواعد التي قمت بتحديدها للتو. يتم تحديد جميع الأساليب بشكل افتراضي.
9. (اختياري) انقر على قاعدة جديدة لتكوين قاعدة أخرى.

   ملاحظة:

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

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

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

• عنوان 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.

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

بالنسبة إلى ALL METHODS to 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

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

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

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

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

1. إذا لم يكن الموصل مفتوحًا بالفعل، فانقر على وحدد التطوير، ثم واجهات api من القائمة الجانبية.
2. حدد واجهة API للموصل الذي تريد تحريره وانقر على فتح.
3. حدد التأمين.
4. حدد نظام التأمين من قائمة الأنظمة المتاحة وانقر على السهم الأيسر لنقله إلى قائمة "الأنظمة المحددة".
   حدد نظامًا واحدًا فقط لواجهة API للموصل. يتم عرض وصف للنظام المحدد أسفل القائمة.
5. حدد التجاوزات، إن أمكن، إلى السياسة المحددة إذا لم ترغب في استخدام القيم الافتراضية.
   لتجاوز خاصية، أدخل قيمة غير القيمة الافتراضية أو حددها.
6. انقر على حفظ لحفظ العمل الذي نفذته أو حفظ وإغلاق لحفظ العمل الذي نفذته والخروج من معالج REST Connector API.
7. انقر على التالي (>) للانتقال إلى الخطوة التالية.