أدوات التطوير

أنت تعرض مستندات Apigee Edge.
انتقل إلى مستندات Apigee X. معلومات

بصفتك مقدّم خدمة، يمكنك تطوير واجهات برمجة التطبيقات لاستهلاكها من قِبل تطبيقات العملاء. لإنشاء أو ضبط وصيانة الخوادم الوكيلة لواجهة برمجة التطبيقات ومنتجات واجهة برمجة التطبيقات، فيمكنك استخدام واجهة المستخدم أو إجراء طلبات HTTP إلى واجهات برمجة التطبيقات للوصول إلى خدمات RESTful، كما هو موضَّح في الأقسام التالية.

استخدام واجهة مستخدم Edge

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

يصف الجدول التالي كيفية الوصول إلى واجهة مستخدم Edge:

https://apigee.com/edge

http://ms-ip:9000

باستخدام واجهة مستخدم Edge، يمكنك إجراء ما يلي:

• يمكنك إنشاء خوادم وكيلة لواجهة برمجة التطبيقات عن طريق تعديل الرمز وتتبُّع تدفقات الطلبات عبر الخوادم الوكيلة.
• إنشاء منتجات واجهة برمجة التطبيقات التي تعمل على تجميع الخوادم الوكيلة لعرض طلبات العملاء
• إدارة تطبيقات المطوّرين
• ضبط بيئات الاختبار والإنتاج
• تنفيذ تطبيقات JavaScript وNode.js

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

استخدام واجهة برمجة تطبيقات Edge

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

غالبًا ما تأخذ نقاط نهاية واجهة برمجة التطبيقات بيانات تحتوي على معلومات الإعدادات وتتطلب منك ما يلي: معلومات المصادقة، مثل اسم المستخدم وكلمة المرور، للوصول إليها. متابعة RESTful يمكنك استدعاء HTTP GET، وPOST، وPUT، DELETE على أي من موارد واجهة برمجة التطبيقات.

للحصول على قائمة كاملة بواجهات برمجة تطبيقات Apigee Edge، يمكنك الاطّلاع على مرجع Apigee Edge API

التعرّف على قاعدة واجهة برمجة تطبيقات Edge مسار

يجمع المسار الذي ستستخدمه في طلبات واجهة برمجة التطبيقات ما يلي:

• مسار أساسي يتضمّن اسم مؤسستك. مثل: https://api.enterprise.apigee.com/v1/organizations/org_name
• نقطة نهاية تشير إلى مورد Edge الذي تصل إليه.

على سبيل المثال، إذا كان اسم مؤسستك هو apibuilders، سيتم عندها إجراء كل مكالمة ستستخدم واجهة برمجة التطبيقات المسار الأساسي التالي:

https://api.enterprise.apigee.com/v1/organizations/apibuilders

لاسترداد قائمة بالخوادم الوكيلة لواجهة برمجة التطبيقات في مؤسستك، يمكنك طلب GET على:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/apis

يتم تحديد نطاق العديد من الموارد حسب البيئة. يتم توفير بيئتين بشكل افتراضي: الاختبار إنتاج. على سبيل المثال، يتم تحديد نطاق ذاكرات التخزين المؤقت حسب البيئة. ذاكرة تخزين مؤقت مشتركة باسم "mycache" متضمن بشكل افتراضي في كل بيئة.

يمكنك إدراج ذاكرات التخزين المؤقت من خلال استدعاء GET في مورد ذاكرة التخزين المؤقت على النحو التالي:

https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/test/caches
https://api.enterprise.apigee.com/v1/organizations/apibuilders/environments/prod/caches

مصادقة الوصول

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

• OAuth2
• SAML
• المصادقة الأساسية (غير مستحسن)

إضافةً إلى ذلك، تنصح Apigee باستخدام المصادقة الثنائية، كما هو موضَّح في تفعيل المصادقة الثنائية لحسابك على Apigee

حدود واجهة برمجة تطبيقات Edge

تقتصر كل مؤسسة على الأسعار التالية لطلب بيانات من واجهة برمجة تطبيقات Edge:

• 10,000 اتصال في الدقيقة للمؤسسات المشترِكة في الخطط المدفوعة
• 600 اتصال في الدقيقة للمؤسسات التي تتضمن فترة تجريبية

لا يتم احتساب رمزَي حالة HTTP 401 و403 ضمن هذا الحدّ. أي مكالمات تتجاوز هذه على إرجاع رمز الحالة 429 Too Many Requests.

نصائح للعمل باستخدام واجهات برمجة تطبيقات Edge

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

عناوين URL المختصرة للطلبات

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

• /e = /environments
• /o = /organizations
• /r = /revisions

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

على سبيل المثال:

THIS:
https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/environments/prod/apis/helloworld/revisions/1/deployments
CAN BE MUCH SHORTER:
https://api.enterprise.apigee.com/v1/o/ahamilton-eval/e/prod/apis/helloworld/r/1/deployments

تنفيذ أوامر التجعيد

استخدِم عميل HTTP لتقديم طلبات إلى واجهة برمجة التطبيقات. أمثلة عديدة في التوثيق تقديم نماذج من طلبات البيانات من واجهة برمجة التطبيقات باستخدام curl، وهو عميل HTTP شائع الاستخدام. إذا كنت بحاجة إلى تثبيت curl، ويمكنك تنزيله من http://curl.haxx.se.

الطلبات إلى واجهة برمجة التطبيقات التي تدعم ضغط gzip مفعّلة الردود. في حال ضبط 'Accept-Encoding: gzip, deflate' في طلبات البيانات من واجهة برمجة التطبيقات، سيتم توفير أي استجابة أكبر من 1024 بايت يتم عرضها بتنسيق gzip.

تنسيق طلبات واستجابات XML وJSON

تعرض واجهة برمجة التطبيقات Edge البيانات كملف JSON تلقائيًا. يمكنك تلقّي الردّ على العديد من الطلبات. إرسالها مرة أخرى بتنسيق XML بدلاً من ذلك. لإجراء ذلك، عليك ضبط عنوان طلب "Accept" على application/xml، كما يبيِّن المثال التالي:

curl -H "Authorization: Bearer `get_token`" \
  -H "Accept: application/xml" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  | xmllint --format -

يجب أن يبدو الرد على النحو التالي:

<List>
  <Item>SOAP-Message-Validation-1</Item>
  <Item>Spike-Arrest-1</Item>
  <Item>XML-to-JSON-1</Item>
</List>

يُرجى العلم أنّ هذا المثال يستخدم prettyprint لعرض النتائج من خلال تمرير الاستجابة xmllint

لا تتيح الأداة acurl استخدام عنوان Accept. نتيجةً لذلك، يمكنك الحصول على ردود بتنسيق JSON فقط باستخدام acurl

لاستخدام prettyprint لاستجابة JSON، يمكنك الاستعانة بمكتبة json.tool في Python:

curl https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval/apis/helloworld/revisions/1/policies/ \
  -H "Accept: application/json" \
  -H "Authorization: Bearer `get_token`" \
  | python -m json.tool

يقدم ما يلي مثالاً على الرد:

[
  "SOAP-Message-Validation-1",
  "Spike-Arrest-1",
  "XML-to-JSON-1"
]

بالنسبة إلى XML، يمكنك استخدام xmllint:

curl https://ahamilton-eval-test.apigee.net/getstarted -u email_address | xmllint --format -

عند نشر حمولات بيانات أو نقلها في XML، استخدِم عنوان HTTP يتضمّن العنصر Content-type:

acurl -H "Content-type:text/xml" -X POST -d \
'<XMLPayload>
 </XMLPayload> ' \
https://api.enterprise.apigee.com/v1/organizations/apifactory/apis -u email_address

بيئات النشر

كل مؤسسة تستخدم Apigee Edge بشكل تلقائي لديها بيئتان على الأقل يمكن استخدامهما من أجل تطوير واجهات برمجة التطبيقات واختبارها ونشرها: "test" و"إنتاج". استخدام "الاختبار" بيئة تطوير لواجهات برمجة التطبيقات قبل إتاحتها للجميع. يمكن للمطوّرين الداخليين فقط الوصول إلى واجهات برمجة التطبيقات. نشره إلى بيئة الاختبار. نشر واجهات برمجة التطبيقات في "الإنتاج" بيئة عمل لجعلها متاحة للجميع المتاحة لمطوّري التطبيقات.

تصحيح الأخطاء والاختبار

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

نقاط البيانات الرئيسية التي يجب استخدامها في تحديد المشاكل وحلّها:

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

يوضّح الشكل التالي نتائج آثار الأنشطة:

يتم تقسيم كل جلسة تتبُّع إلى الخطوات الرئيسية التالية:

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