إنشاء خادم وكيل لواجهة برمجة التطبيقات من مواصفات OpenAPI | Apigee Edge

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

لمحة عن "مبادرة واجهات برمجة التطبيقات المفتوحة"

"تركّز مبادرة Open API (OAI) على إنشاء وتطوير وترويج تنسيق وصف واجهة برمجة تطبيقات محايد للمورّد بناءً على نموذج التخاطر المواصفات". لمزيد من المعلومات حول مبادرة واجهة برمجة التطبيقات المفتوحة، يمكنك الاطّلاع على https://openapis.org.

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

لمحة عن خدمة Apigee التجريبية المستهدفة

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

http://mocktarget.apigee.net

تعرض الخدمة المستهدفة رسالة الترحيب Hello, guest!.

للحصول على معلومات حول المجموعة الكاملة من واجهات برمجة التطبيقات التي تدعمها خدمة الهدف الزائف، انقر على التالي:

http://mocktarget.apigee.net/help

المتطلبات

حساب على Apigee Edge إذا لم يكن لديك حساب، يمكنك الاشتراك من خلال اتّباع التعليمات في مقالة إنشاء Apigee Edge الحساب.
إحدى مواصفات OpenAPI. في هذا الدليل التعليمي، ستستخدم mocktarget.yaml مواصفات OpenAPI التي تصف الهدف التجريبي في Apigee الخدمة، http://mocktarget.apigee.net. لمزيد من المعلومات، يُرجى مراجعة https://github.com/apigee/api-platform-samples/tree/master/default-proxies/helloworld/openapi
cURL المثبّت على جهازك لإجراء طلبات البيانات من واجهة برمجة التطبيقات من سطر الأوامر؛ أو متصفح ويب.

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

Edge

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

سجِّل الدخول إلى https://apigee.com/edge.
انقر على خوادم وكيلة واجهة برمجة التطبيقات في النافذة الرئيسية.
يمكنك بدلاً من ذلك اختيار التطوير >. الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
انقر على + خادم وكيل.
في معالج إنشاء خادم وكيل، انقر على استخدام مواصفات OpenAPI لنموذج الخادم الوكيل العكسي (الأكثر شيوعًا).
انقر على استيراد من عنوان URL وأدخِل المعلومات التالية:
- عنوان URL لمواصفات OpenAPI: المسار إلى المحتوى الأولي على GitHub لمواصفات OpenAPI في حقل عنوان URL:
```
https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
```
- اسم المواصفات: اسم مواصفات OpenAPI، مثل الهدف الزائف.
  يُستخدم هذا الاسم لتخزين مواصفات OpenAPI في مخزن المواصفات. ويمكنك الاطّلاع على إدارة المواصفات.

انقر على استيراد.

تظهر صفحة التفاصيل في معالج إنشاء خادم وكيل. تمت تعبئة الحقول تلقائيًا. باستخدام القيم المحددة في مواصفات OpenAPI، كما هو موضح في

يصف الجدول التالي القيم التلقائية التي تتم تعبئتها تلقائيًا باستخدام في مواصفات OpenAPI. مقتطف من مواصفات OpenAPI لتوضيح الخصائص المستخدمة، كما هو موضح بعد الجدول.

الحقل	الوصف	تلقائي
الاسم	اسم الخادم الوكيل لواجهة برمجة التطبيقات مثلاً: `Mock-Target-API`	السمة `title` من مواصفات OpenAPI مع استبدال المسافات بشرطات
المسار الأساسي	مكوّن المسار الذي يعرّف الخادم الوكيل لواجهة برمجة التطبيقات هذا بشكل فريد داخل المؤسسة يتألف عنوان URL الذي يظهر بشكل علني للخادم الوكيل لواجهة برمجة التطبيقات هذا من اسم مؤسستك، حيث يتم نشر الخادم الوكيل لواجهة برمجة التطبيقات هذا، وهذا المسار الأساسي. بالنسبة مثال: `http://myorg-test.apigee.net/mock-target-api`	تم تحويل محتوى حقل الاسم إلى أحرف صغيرة.
الوصف	وصف الخادم الوكيل لواجهة برمجة التطبيقات.	`description` من مواصفات OpenAPI
الاستهداف (واجهة برمجة التطبيقات الحالية)	تم استدعاء عنوان URL المستهدف نيابةً عن الخادم الوكيل لواجهة برمجة التطبيقات هذا. أي عنوان URL يمكن الوصول إليه عبر شبكة الإنترنت المفتوحة. مثل: `http://mocktarget.apigee.net`	`servers` من مواصفات OpenAPI

يقدم ما يلي مقتطفًا من مواصفات OpenAPI توضح الخصائص التي تستخدم لملء الحقول مسبقًا.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

عدِّل حقل الوصف على النحو التالي: API proxy for the Apigee mock target service endpoint.
انقر على التالي.
في صفحة السياسات الشائعة، ضمن "الأمان: التفويض"، تأكَّد من اختيار اجتياز (بدون تفويض)، وانقر على التالي:
في صفحة "التدفقات"، تأكد من اختيار جميع العمليات.
ملاحظة: يتم إنشاء تدفقات شرطية تلقائيًا من العمليات المحدّدة في الكائن paths في OpenAPI المواصفات تخبر التدفقات الشرطية Edge، "عندما ترى هذا، نفذ هذا المنطق". على سبيل المثال، عندما يكون طلب بيانات من واجهة برمجة التطبيقات هو عملية GET على مورد /xml (الشرط)، تحويل الاستجابة إلى JSON (من خلال سياسة مرتبطة بالتدفق الشرطي). فقط يتم تنفيذ تدفق واحد لكل معاملة - التدفق الأول الذي يتم تقييم شرطه صحيح.
انقر على التالي.
في صفحة المضيفات الافتراضية، حدد افتراضي وآمن، وانقر على التالي.
في صفحة الملخّص، تأكّد من أنّ بيئة الاختبار هي ضمن النشر الاختياري وانقر على إنشاء deploy:

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

الإصدار الكلاسيكي Edge (السحابة الإلكترونية الخاصة)

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

سجِّل الدخول إلى https://apigee.com/edge.
انقر على خوادم وكيلة واجهة برمجة التطبيقات في النافذة الرئيسية.
يمكنك بدلاً من ذلك اختيار التطوير >. الخوادم الوكيلة لواجهة برمجة التطبيقات في شريط التنقل الأيمن.
انقر على + خادم وكيل.
في معالج إنشاء خادم وكيل، حدد الخادم الوكيل العكسي (الأكثر شيوعًا) ثم انقر على استخدام OpenAPI.
انقر على استيراد من عنوان URL، وأدخِل اسمًا لمواصفات OpenAPI، وأدخِل مسار المحتوى الأولي على GitHub لواجهة OpenAPI. المواصفات في حقل عنوان URL:

https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml
انقر على اختيار.

انقر على التالي.

تظهر صفحة التفاصيل في معالج إنشاء خادم وكيل. تمت تعبئة الحقول تلقائيًا. باستخدام القيم المحددة في مواصفات OpenAPI، كما هو موضح في الشكل.

يصف الجدول التالي القيم التلقائية التي تتم تعبئتها تلقائيًا باستخدام في مواصفات OpenAPI. مقتطف من مواصفات OpenAPI لتوضيح الخصائص المستخدمة، كما هو موضح بعد الجدول.

الحقل	الوصف	تلقائي
اسم الخادم الوكيل	اسم الخادم الوكيل لواجهة برمجة التطبيقات مثلاً: `Mock-Target-API`	السمة `title` من مواصفات OpenAPI مع استبدال المسافات بشرطات
المسار الأساسي للخادم الوكيل	مكوّن المسار الذي يعرّف الخادم الوكيل لواجهة برمجة التطبيقات هذا بشكل فريد داخل المؤسسة يتألف عنوان URL الذي يظهر بشكل علني للخادم الوكيل لواجهة برمجة التطبيقات هذا من اسم مؤسستك، حيث يتم نشر الخادم الوكيل لواجهة برمجة التطبيقات هذا، وهذا المسار الأساسي. بالنسبة مثال: `http://myorg-test.apigee.net/mock-target-api`	تم تحويل محتوى حقل الاسم إلى أحرف صغيرة.
واجهة برمجة التطبيقات الحالية	تم استدعاء عنوان URL المستهدف نيابةً عن الخادم الوكيل لواجهة برمجة التطبيقات هذا. أي عنوان URL يمكن الوصول إليه عبر شبكة الإنترنت المفتوحة. مثل: `http://mocktarget.apigee.net`	`servers` من مواصفات OpenAPI
الوصف	وصف الخادم الوكيل لواجهة برمجة التطبيقات.	`description` من مواصفات OpenAPI

يقدم ما يلي مقتطفًا من مواصفات OpenAPI توضح الخصائص التي تستخدم لملء الحقول مسبقًا.

openapi: 3.0.0
info:
  description: OpenAPI Specification for the Apigee mock target service endpoint.
  version: 1.0.0
  title: Mock Target API
paths:
  /:
    get:
      summary: View personalized greeting
      operationId: View a personalized greeting
      description: View a personalized greeting for the specified or guest user.
      parameters:
        - name: user
          in: query
          description: Your user name.
          required: false
          schema:
            type: string
      responses:
        "200":
          description: Success
...
servers:
  - url: http://mocktarget.apigee.net
  - url: https://mocktarget.apigee.net
...

عدِّل حقل الوصف على النحو التالي: API proxy for the Apigee mock target service endpoint.
انقر على التالي.
في صفحة "التدفقات"، تأكد من اختيار جميع العمليات.
ملاحظة: يتم إنشاء تدفقات شرطية تلقائيًا من العمليات المحدّدة في الكائن paths في OpenAPI المواصفات تخبر التدفقات الشرطية Edge، "عندما ترى هذا، نفذ هذا المنطق". على سبيل المثال، عندما يكون طلب بيانات من واجهة برمجة التطبيقات هو عملية GET على مورد /xml (الشرط)، تحويل الاستجابة إلى JSON (من خلال سياسة مرتبطة بالتدفق الشرطي). فقط يتم تنفيذ تدفق واحد لكل معاملة - التدفق الأول الذي يتم تقييم شرطه صحيح.
انقر على التالي.
في صفحة "الأمان"، اختَر تمرير (بدون) كأمان البيانات. وانقر على التالي.
في صفحة المضيفات الافتراضية، تأكد من تحديد جميع المضيفات الظاهرية وانقر فوق التالي.
في صفحة "الإصدار"، تأكَّد من اختيار بيئة الاختبار. انقر على إنشاء ونشر.
في صفحة "الملخّص"، يظهر لك إقرار بإنشاء الخادم الوكيل الجديد لواجهة برمجة التطبيقات. بنجاح ونشره في بيئة الاختبار.
انقر على Mock-Target-API لعرض صفحة النظرة العامة الخاصة بواجهة برمجة التطبيقات. الخادم الوكيل.

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

اختبار الخادم الوكيل لواجهة برمجة التطبيقات

يمكنك اختبار واجهة برمجة تطبيقات Mock-Target-API باستخدام cURL أو متصفّح ويب.

في نافذة طرفية، شغِّل أمر cURL التالي: استبدِل اسم مؤسستك في عنوان URL.

curl http://<org_name>-test.apigee.net/mock-target-api

الردّ

من المفترض أن يظهر لك الرد التالي:

Hello, Guest!

أحسنت. لقد أنشأت خادمًا وكيلاً بسيطًا لواجهة برمجة التطبيقات من خلال مواصفات OpenAPI واختبرته بها.

إضافة ملف XML إلى سياسة JSON

بعد ذلك، ستضيف سياسة XML إلى JSON إلى عرض استجابة XML. التدفق الشرطي الذي تم إنشاؤه تلقائيًا عند إنشاء الخادم الوكيل لواجهة برمجة التطبيقات من مواصفات OpenAPI. ستحوِّل السياسة استجابة XML للاستهداف إلى ملف JSON. الاستجابة.

عليك أولاً طلب بيانات من واجهة برمجة التطبيقات لتتمكّن من مقارنة النتائج مع النتائج التي حصلت عليها بعد الإضافة. السياسة. في نافذة طرفية، نفِّذ أمر cURL التالي. أنت تطلب مورد /xml التابع للخدمة، والذي يعرض في الأصل كتلة بسيطة من XML. استبدِل اسم مؤسستك في عنوان URL.

curl http://<org_name>-test.apigee.net/mock-target-api/xml

الردّ

من المفترض أن يظهر لك الرد التالي:

<root> 
  <city>San Jose</city> 
  <firstName>John</firstName> 
  <lastName>Doe</lastName> 
  <state>CA</state> 
</root>

لننفِّذ الآن إجراءً يحوِّل استجابة XML إلى JSON. إضافة ملف XML إلى سياسة JSON إلى التدفق الشرطي لعرض استجابة XML في الخادم الوكيل لواجهة برمجة التطبيقات.

انقر على علامة التبويب Develop (تطوير) في أعلى يسار واجهة Mock-Target-API. صفحة نظرة عامة في واجهة مستخدم Edge.
في جزء المستكشف، ضمن نقاط نهاية الخادم الوكيل > انقر على زر عرض المسار المشروط لاستجابة XML
انقر على زر +خطوة السفلي، المقابل لـ الردّ على مسار العملية

يفتح مربع الحوار "إضافة خطوة" يعرض قائمة مصنفة بجميع السياسات التي يمكنك إضافة.
انتقِل إلى فئة "التوسّط" واختَر XML إلى JSON.
إبقاء القيم التلقائية لـ الاسم المعروض الاسم:
انقر على إضافة. يتم تطبيق سياسة XML إلى JSON على الاستجابة.
انقر على حفظ.

بعد أن أضفت السياسة، يمكنك طلب بيانات من واجهة برمجة التطبيقات مجددًا باستخدام أمر cURL. لاحظ أنك لا تزال يستدعي المورد /xml نفسه. لا تزال الخدمة المستهدفة تقوم بإرجاع مجموعة XML، ولكن الآن ستحوِّل السياسة في الخادم الوكيل لواجهة برمجة التطبيقات الرد إلى JSON. تحضير هذا الاتصال:

curl http://<org_name>-test.apigee.net/mock-target-api/xml

تجدر الإشارة إلى أنّه يتم تحويل استجابة XML إلى تنسيق JSON:

{"root":{"city":"San Jose","firstName":"John","lastName":"Doe","state":"CA"}}

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