تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
مستكشف واجهات برمجة تطبيقات Google هو أداة متوفرة على معظم صفحات مستندات REST API
التي تتيح لك تجربة طرق Google API بدون كتابة الرمز.
يعمل "مستكشف واجهات برمجة التطبيقات" على البيانات الفعلية، لذا توخَ الحذر عند تجربة الطرق التي تنشئ أو تعدّل أو تحذف البيانات.
استخدام الدليل
للحصول على قائمة بواجهات برمجة تطبيقات Google التي يمكنك استكشافها، تصفَّح دليل مستكشف واجهات برمجة تطبيقات Google. تحتوي هذه القائمة على روابط
إلى وثائق واجهة برمجة التطبيقات المرجعية لواجهات برمجة التطبيقات المتوافقة. اتّبِع الخطوات التالية لاستكشاف واجهة برمجة التطبيقات:
في مربّع البحث في أعلى الشاشة، أدخِل اسم واجهة برمجة التطبيقات التي تريد استكشافها.
انقر على اسم واجهة برمجة التطبيقات. يؤدي هذا إلى فتح المستندات المرجعية لواجهة برمجة التطبيقات.
على يمين الصفحة، انقر على الطريقة التي تريد استخدامها في شريط التنقّل.
على يسار الصفحة، ابحث عن اللوحة التي تحمل التصنيف "&&جرِّب هذه الطريقة".& يُرجى الاطّلاع على التفاصيل أدناه حول كيفية استخدام اللوحة الجانبية في "مستكشف واجهات برمجة التطبيقات" وكيفية توسيعها إلى لوحة "مستكشف واجهات برمجة التطبيقات بملء الشاشة".
استخدام اللوحة الجانبية
الشكل 1: اللوحة الجانبية في "مستكشف واجهات برمجة التطبيقات" لواجهة برمجة التطبيقات "لكتب Google".
يظهر مستكشف واجهات برمجة التطبيقات بشكل تلقائي على الجانب الأيسر من الشاشة في مستندات مرجع واجهة برمجة التطبيقات للطرق المعتمدة.
يمكنك تخصيص الأقسام التالية والتفاعل معها في اللوحة الجانبية لـ APIs Explorer:
معلَمات الطلب، إذا كانت مطلوبة بالطريقة.
نص الطلب: إذا كانت الطريقة مطلوبة.
بيانات الاعتماد، لاختبار الطريقة باستخدام أنواع مختلفة من بيانات الاعتماد والنطاقات.
زر تنفيذ لتشغيل الطريقة باستخدام المعلمات والإعدادات التي حدّدتها.
النتيجة، يتم عرضها بعد تنفيذ الطريقة فقط.
استخدام لوحة ملء الشاشة
الشكل 2: لوحة ملء واجهة برمجة التطبيقات في "مستكشف واجهات برمجة التطبيقات" في "كتب Google"
في اللوحة المصغّرة لـ APIs Explorer، يمكنك النقر على"ملء الشاشة"fullscreen لتوسيع مستكشف واجهات برمجة التطبيقات. تعرض اللوحة في وضع ملء الشاشة جزءًا إضافيًا يحتوي على نماذج للرمز، وapplication/json رد، واستجابات HTTP غير منسقة.
المصادقة
يستخدم مستكشف واجهات برمجة التطبيقات بيانات اعتماده الخاصة لتقديم طلب. لا يمكنك استخدام بيانات الاعتماد المخصّصة مع مستكشف واجهات برمجة التطبيقات.
تنسيقات البيانات
لا يتوافق مستكشف واجهات برمجة التطبيقات إلا مع JSON للردود وطلب حمولات. حتى في حال كانت واجهة برمجة التطبيقات تتيح استخدام تنسيقات بيانات أخرى، لن تعمل هذه التنسيقات في "مستكشف واجهات برمجة التطبيقات".
تاريخ التعديل الأخير: 2022-11-01 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2022-11-01 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eGoogle APIs Explorer allows you to experiment with Google API methods directly without coding, using real data.\u003c/p\u003e\n"],["\u003cp\u003eYou can find the desired API through the Google APIs Explorer Directory and navigate to its documentation to access the Explorer.\u003c/p\u003e\n"],["\u003cp\u003eThe Explorer provides an interface to input parameters, request bodies, and credentials for executing the API method and viewing results.\u003c/p\u003e\n"],["\u003cp\u003eWhile the Explorer uses its own credentials, it offers both side-panel and full-screen views with functionalities like code samples and response formats in JSON.\u003c/p\u003e\n"],["\u003cp\u003eRemember to exercise caution when using methods that modify data, as the Explorer operates on live data.\u003c/p\u003e\n"]]],[],null,["# Overview\n\nThe Google APIs Explorer is a tool available on most REST API method\ndocumentation pages that lets you try Google API methods without writing code.\nThe APIs Explorer acts on real data, so use caution when trying methods that\ncreate, modify, or delete data.\n\nUse the directory\n-----------------\n\nFor a list of Google APIs you can explore, browse the\n[Google APIs Explorer Directory](/apis-explorer). This list contains links to\nthe API reference documentation for supported APIs. Follow the steps below to\nexplore the API:\n\n1. Open the [Google APIs Explorer Directory](/apis-explorer).\n2. In the search box at the top, enter the name of the API you want to explore.\n3. Click the name of the API. This opens the API reference documentation.\n4. At the left, click the method you want to use in the navigation.\n5. At the right, find the panel labeled \"Try this method.\" See below for details\n about how to use the APIs Explorer side panel and how to expand it into the\n full-screen APIs Explorer panel.\n\n | **Note:** If you don't see the APIs Explorer side panel, the method might not be compatible with APIs Explorer.\n\nUse the side panel\n------------------\n\n**Figure 1**: APIs Explorer side panel for the Google Books API.\n\nBy default, the APIs Explorer appears on the right-hand side of the screen in\nAPI reference documentation for supported methods.\n\nYou can customize and interact with the following sections in the APIs Explorer\nside panel:\n\n- **Request parameters**, if required by the method.\n- **Request body**, if required by the method.\n- **Credentials**, to test the method with various credential types and scopes.\n- **Execute** button, to run the method using the parameters and settings you've specified.\n- **Result**, displayed only after executing the method.\n\nUse the full-screen panel\n-------------------------\n\n**Figure 2**: APIs Explorer full-screen panel for the Google Books API.\n\nIn the collapsed APIs Explorer side panel, you can click Full screen\nfullscreen to expand the APIs Explorer. The\nfull-screen panel displays an extra pane containing code samples,\n`application/json` responses, and Raw HTTP responses.\n\nAuthentication\n--------------\n\nThe APIs Explorer uses its own credentials to make a request. You can't use\ncustom credentials with the APIs Explorer.\n\nData formats\n------------\n\nThe APIs Explorer only supports JSON for responses and request payloads. Even if\nyour API supports other data formats, these formats don't work in the\nAPIs Explorer.\n\nNext steps\n----------\n\n- Learn how to [display the APIs Explorer and execute a method](/explorer-help/execute-method).\n- Learn how to [test a method using different credentials and scopes](/explorer-help/authorization-and-authentication).\n- Learn how to [execute APIs Explorer sample code locally](/explorer-help/code-samples)."]]
