نظرة عامة

مستكشف واجهات برمجة تطبيقات Google هو أداة متوفرة على معظم صفحات مستندات REST API التي تتيح لك تجربة طرق Google API بدون كتابة الرمز. يعمل "مستكشف واجهات برمجة التطبيقات" على البيانات الفعلية، لذا توخَ الحذر عند تجربة الطرق التي تنشئ أو تعدّل أو تحذف البيانات.

استخدام الدليل

للحصول على قائمة بواجهات برمجة تطبيقات Google التي يمكنك استكشافها، تصفَّح دليل مستكشف واجهات برمجة تطبيقات Google. تحتوي هذه القائمة على روابط إلى وثائق واجهة برمجة التطبيقات المرجعية لواجهات برمجة التطبيقات المتوافقة. اتّبِع الخطوات التالية لاستكشاف واجهة برمجة التطبيقات:

  1. افتح دليل Google APIs Explorer.
  2. في مربّع البحث في أعلى الشاشة، أدخِل اسم واجهة برمجة التطبيقات التي تريد استكشافها.
  3. انقر على اسم واجهة برمجة التطبيقات. يؤدي هذا إلى فتح المستندات المرجعية لواجهة برمجة التطبيقات.
  4. على يمين الصفحة، انقر على الطريقة التي تريد استخدامها في شريط التنقّل.
  5. على يسار الصفحة، ابحث عن اللوحة التي تحمل التصنيف "&&جرِّب هذه الطريقة".& يُرجى الاطّلاع على التفاصيل أدناه حول كيفية استخدام اللوحة الجانبية في "مستكشف واجهات برمجة التطبيقات" وكيفية توسيعها إلى لوحة "مستكشف واجهات برمجة التطبيقات بملء الشاشة".

استخدام اللوحة الجانبية

اللوحة الجانبية لـ APIs Explorer لواجهة برمجة التطبيقات "لكتب Google"
الشكل 1: اللوحة الجانبية في "مستكشف واجهات برمجة التطبيقات" لواجهة برمجة التطبيقات "لكتب Google".

يظهر مستكشف واجهات برمجة التطبيقات بشكل تلقائي على الجانب الأيسر من الشاشة في مستندات مرجع واجهة برمجة التطبيقات للطرق المعتمدة.

يمكنك تخصيص الأقسام التالية والتفاعل معها في اللوحة الجانبية لـ APIs Explorer:

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

استخدام لوحة ملء الشاشة

لوحة ملء واجهات برمجة التطبيقات في مستكشف واجهة برمجة التطبيقات في "كتب Google"
الشكل 2: لوحة ملء واجهة برمجة التطبيقات في "مستكشف واجهات برمجة التطبيقات" في "كتب Google"

في اللوحة المصغّرة لـ APIs Explorer، يمكنك النقر على"ملء الشاشة" لتوسيع مستكشف واجهات برمجة التطبيقات. تعرض اللوحة في وضع ملء الشاشة جزءًا إضافيًا يحتوي على نماذج للرمز، وapplication/json رد، واستجابات HTTP غير منسقة.

المصادقة

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

تنسيقات البيانات

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

الخطوات اللاحقة