تعرف على تصميم واجهة برمجة التطبيقات المخصص

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

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

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

حول عملية تصميم واجهة برمجة التطبيقات

يرشدك مصمم واجهة برمجة التطبيقات خلال عملية تكوين واجهة برمجة تطبيقات مخصصة.

يمكنك إنشاء نسخة مسودة من واجهة برمجة التطبيقات بسرعة في بضع خطوات:

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

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

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

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

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

حول تكوين واجهات برمجة التطبيقات المخصصة للموصلات

يمكن لـ Oracle Mobile Hub إنشاء تعليمات برمجية مخصصة من الموصلات للاتصال بالخدمات الخارجية. كمطور خدمة، يمكنك تحديد موصل Oracle Fusion Applications أو موصل REST تم تكوينه باستخدام واصف صالح، وإنشاء واجهة برمجة تطبيقات مخصصة، واستخدام واجهة برمجة التطبيقات التي تم إنشاؤها لتسهيل استدعاء هذه الخدمات من عمليات تنفيذ واجهات برمجة التطبيقات المخصصة، أو مباشرة من تطبيق الأجهزة المتنقلة.

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

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

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

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

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

يمكنك فقط تكوين واجهة برمجة تطبيقات مخصصة لموصل REST أو تطبيقات Oracle Fusion Cloud، والذي يتم تحديده باستخدام واصف. لا يمكنك تكوين واجهة API مخصصة لنوع آخر من الموصلات، أو عندما لا يكون لموصل REST أو تطبيقات Oracle Fusion Cloud واصف.

إذا كنت تريد إرسال بيانات نموذج متعدد الأجزاء أو استخدام كائن الخيارات http، فقد تحتاج إلى استبدال الأسلوب callConnector في التنفيذ بالتعليمات البرمجية الخاصة بك.

الواجهات البرمجية للتطبيق لموصل REST

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

كيفية عمل واجهات برمجة تطبيقات موصل REST

الواجهة البرمجية للتطبيق لموصل REST هي واجهة برمجة تطبيقات وسيطة لاستدعاء نقاط انتهاء REST في أنظمة المؤسسة أو واجهات برمجة تطبيقات الجهات الخارجية. تأخذ واجهة برمجة تطبيقات الموصل شكل تكوين يمنح تطبيقاتك طريقة قياسية للاتصال بخدمات REST هذه والاستفادة من الأمان والتشخيصات والميزات الأخرى التي توفرها Oracle Mobile Hub.

يقوم الموصل بتوصيل المعلومات بين العميل والخادم وتمريرها باستخدام بروتوكول HTTPS. يمكن أن تكون المعلومات التي تم تمريرها في شكل XML أو JSON (ولكن فقط في JSON للخدمات المستندة إلى واصفات Swagger).

يرشدك معالج الواجهة البرمجية للتطبيق لموصل REST من خلال تكوين واجهات برمجة تطبيقات موصل REST، بدءًا من تحديد خدمة بعيدة وتعيين نُهج الأمان لاختبار نقاط الانتهاء.

لماذا استخدام الموصلات بدلاً من المكالمات المباشرة إلى الموارد الخارجية؟

يوفر لك استخدام الواجهة البرمجية للتطبيق لموصل REST المزايا التالية لإجراء مكالمات مباشرة من رمز التطبيق إلى الموارد الخارجية:

السماح بالاتصال التعريفي المبسط وتكوين النهج.
باستخدام واصف Swagger، يحدد الموارد المتاحة ويقوم بتكوين نقاط انتهاء لك.
توفر لك معلومات تشخيصية شاملة لأنها متكاملة تمامًا مع إطار تشخيص Oracle Mobile Hub. يتم تسجيل أي استدعاءات REST صادرة تتم من خلال واجهات برمجة تطبيقات الموصل، مما يساعد بشكل كبير في تصحيح الأخطاء.
يسمح بالتتبع والتحليلات حول استخدام API عن بُعد.
يتيح لك تحديد التفاعل مع الخدمة في وقت التصميم عند اختبار صلاحية نقاط النهاية بحيث لا تعتمد شروط هذا التفاعل على إدخال المستخدم في وقت التشغيل. هذا يحمي كل من النظام النهائي والواجهة الخلفية المتنقلة الخاصة بك من الضرر.
يوفر أسلوب تصميم متسق بين أنواع الموصلات المتعددة للتفاعل مع الخدمات الخارجية.
مع أي تغيير في واجهة الخدمة، يتيح لك التعامل مع أي تحديثات واختبار وترحيل ضرورية في مكان واحد.