سند کشف: فهرست

فهرست APIهای پشتیبانی‌شده در این نقطه پایانی را بازیابی کنید.

متد discovery.apis.list فهرستی از تمام APIهای پشتیبانی‌شده توسط سرویس کشف APIهای گوگل را برمی‌گرداند. داده‌های هر ورودی، زیرمجموعه‌ای از سند کشف برای آن API است و این فهرست، فهرستی از APIهای پشتیبانی‌شده را ارائه می‌دهد. اگر یک API خاص چندین نسخه داشته باشد، هر یک از نسخه‌ها ورودی مخصوص به خود را در فهرست دارند.

درخواست

درخواست HTTP 

GET https://discovery.googleapis.com/discovery/v1/apis

پارامترها

نام پارامتر ارزش توضیحات
پارامترهای اختیاری
name string فقط APIهایی را که نام داده شده دارند، لحاظ کنید.
preferred boolean فقط نسخه ترجیحی یک API را برمی‌گرداند. به طور پیش‌فرض " false " است.

درخواست بدنه

با این روش، بدنه درخواست را ارائه ندهید.

پاسخ

در صورت موفقیت، این متد یک بدنه پاسخ با ساختار زیر برمی‌گرداند: 

{
  "kind": "discovery#directoryList",
  "discoveryVersion": "v1",
  "items": [
    {
      "kind": "discovery#directoryItem",
      "id": string,
      "name": string,
      "version": string,
      "title": string,
      "description": string,
      "discoveryRestUrl": string,
      "discoveryLink": string,
      "icons": {
        "x16": string,
        "x32": string
      },
      "documentationLink": string,
      "labels": [
        string
      ],
      "preferred": boolean
    }
  ]
}
نام ملک ارزش توضیحات
kind string کشف رشته ثابت#directoryList
discoveryVersion string نسخه API دیسکاوری مورد استفاده برای تولید این سند را مشخص کنید.
items[] list ورودی‌های دایرکتوری به صورت جداگانه. یک ورودی به ازای هر جفت API/نسخه.
items[]. kind string از این نوع برای این پاسخ.
items[]. id string شناسه این API.
items[]. name string نام API.
items[]. version string نسخه API.
items[]. title string عنوان این API.
items[]. description string توضیحات این API.
items[]. discoveryRestUrl string آدرس اینترنتی سند REST اکتشافی.
items[]. icons object لینک‌هایی به آیکون‌های ۱۶x۱۶ و ۳۲x۳۲ که نشان‌دهنده‌ی API هستند.
items[].icons. x16 string آدرس اینترنتی (url) آیکون ۱۶x۱۶.
items[].icons. x32 string آدرس اینترنتی (url) آیکون ۳۲x۳۲.
items[]. labels[] list برچسب‌هایی برای وضعیت این API، مانند limited_availability یا deprecated .
items[]. preferred boolean اگر این نسخه، نسخه ترجیحی برای استفاده باشد، true .