بررسی اجمالی

Google APIs Explorer ابزاری است که در اکثر صفحات مستندسازی روش REST API موجود است که به شما امکان می‌دهد روش‌های Google API را بدون نوشتن کد امتحان کنید. APIs Explorer روی داده‌های واقعی عمل می‌کند، بنابراین هنگام استفاده از روش‌هایی که داده‌ها را ایجاد، اصلاح یا حذف می‌کنند، احتیاط کنید.

از دایرکتوری استفاده کنید

برای فهرستی از APIهای Google که می‌توانید کاوش کنید، فهرست راهنمای Google APIs Explorer را مرور کنید. این لیست حاوی پیوندهایی به اسناد مرجع API برای APIهای پشتیبانی شده است. برای بررسی API مراحل زیر را دنبال کنید:

1. فهرست Google APIs Explorer را باز کنید.
2. در کادر جستجو در بالا، نام API مورد نظر برای کاوش را وارد کنید.
3. روی نام API کلیک کنید. با این کار اسناد مرجع API باز می شود.
4. در سمت چپ، روی روشی که می‌خواهید در پیمایش استفاده کنید کلیک کنید.

5. در سمت راست، پانل با عنوان "این روش را امتحان کنید" را پیدا کنید. برای جزئیات بیشتر در مورد نحوه استفاده از پانل جانبی APIs Explorer و نحوه گسترش آن در پانل APIs Explorer تمام صفحه، به زیر مراجعه کنید.

   توجه: اگر پانل کناری APIs Explorer را نمی‌بینید، ممکن است این روش با APIs Explorer سازگار نباشد.

از پانل کناری استفاده کنید

شکل 1 : پانل کناری APIs Explorer برای Google Books API.

به طور پیش‌فرض، APIs Explorer در سمت راست صفحه در اسناد مرجع API برای روش‌های پشتیبانی‌شده ظاهر می‌شود.

می‌توانید بخش‌های زیر را در پانل کناری APIs Explorer سفارشی کنید و با آن‌ها تعامل داشته باشید:

• در صورت نیاز به روش، پارامترها را درخواست کنید.
• در صورت نیاز به روش، بدن را درخواست کنید.
• اعتبارنامه ، برای آزمایش روش با انواع مختلف اعتبار و دامنه.
• دکمه Execute ، برای اجرای روش با استفاده از پارامترها و تنظیماتی که شما مشخص کرده اید.
• نتیجه ، تنها پس از اجرای روش نمایش داده می شود.

از پنل تمام صفحه استفاده کنید

شکل 2 : پانل تمام صفحه APIs Explorer برای Google Books API.

در پانل کناری APIs Explorer کوچک شده، می‌توانید روی تمام صفحه صفحه کلیک کنید تا APIs Explorer گسترش یابد. پانل تمام صفحه یک صفحه اضافی حاوی نمونه کد، پاسخ application/json و پاسخ های HTTP خام را نمایش می دهد.

احراز هویت

APIs Explorer از اعتبارنامه های خود برای ارسال درخواست استفاده می کند. نمی‌توانید از اعتبارنامه‌های سفارشی با APIs Explorer استفاده کنید.

فرمت های داده

APIs Explorer فقط از JSON برای پاسخ‌ها و بارهای درخواستی پشتیبانی می‌کند. حتی اگر API شما از فرمت های داده دیگر پشتیبانی می کند، این فرمت ها در APIs Explorer کار نمی کنند.

مراحل بعدی

• نحوه نمایش APIs Explorer و اجرای یک روش را بیاموزید.
• بیاموزید که چگونه یک روش را با استفاده از اعتبارنامه ها و دامنه های مختلف آزمایش کنید.
• نحوه اجرای کد نمونه APIs Explorer به صورت محلی را بیاموزید.