تنفيذ واجهة API مخصصة لخدمة REST فاريس

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

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

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

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

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

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

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

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

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

   ملاحظة:

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

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

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

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

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

إضافة طرق لموارد خاصة بك

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

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 في التحقق من سلوك الأساليب. يعرض المثال قيم الوقت للبيانات التي يتم إرسالها في نص الرسالة كما هو محدد في أسلوب 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 لفهم سبب حدوث خطأ محتمل في API الجاري إعداده ، استخدم رمز موقف HTTP لإرجاع الرمز الذي يُطابق أفضل موقف للخطأ.

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

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

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

تكوين API موصل REST

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

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

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

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

• تكوين سياسات سرية في جانب العميل للخدمة التي تقوم بالوصول إليها.

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

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

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

يمكنك تكوين موصل وظيفي من خلال إكمال أول صفحتين في معالج API موصل REST.

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

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

3. حدد واجهة برمجة التطبيقات لموصل REST الجديد عبر إدخال ما يلي:

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

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

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

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

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

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

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

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

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

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

     ملاحظة:

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

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

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

   ملاحظة:

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

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

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

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

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

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

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

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

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

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

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

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

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

   ملاحظة:

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

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

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

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

   ملاحظة:

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

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

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

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

تكوين سياسات السرية وخصائص التجاوز

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

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

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

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