مستند Discovery: القائمة
تنظيم صفحاتك في مجموعات
يمكنك حفظ المحتوى وتصنيفه حسب إعداداتك المفضّلة.
استرداد قائمة واجهات برمجة التطبيقات المتاحة في نقطة النهاية هذه
التجربة الآن
تعرض الطريقة discovery.apis.list قائمة بجميع واجهات برمجة التطبيقات التي تدعمها خدمة استكشاف واجهات برمجة التطبيقات في Google. تكون بيانات كل إدخال مجموعة فرعية من مستند Discovery لواجهة برمجة التطبيقات هذه، وتوفر القائمة دليلاً لواجهات برمجة التطبيقات المتوافقة. إذا كان لواجهة برمجة تطبيقات معينة إصدارات متعددة، يكون لكل نسخة منها إدخال خاص بها في القائمة.
طلب
طلب HTTP
GET https://discovery.googleapis.com/discovery/v1/apis
المعلَمات
اسم المعلّمة |
القيمة |
الوصف |
المعلّمات الاختيارية |
name |
string |
يجب تضمين واجهات برمجة التطبيقات بالاسم نفسه فقط.
|
preferred |
boolean |
اعرض فقط الإصدار المفضَّل من واجهة برمجة التطبيقات. "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 |
السلسلة الثابتة Discovery#directoryList |
|
discoveryVersion |
string |
حدِّد إصدار واجهة برمجة تطبيقات Discovery المستخدَم لإنشاء هذا المستند. |
|
items[] |
list |
إدخالات الدليل الفردي. إدخال واحد لكل زوج من واجهة برمجة التطبيقات/الإصدار. |
|
items[].kind |
string |
نوع هذه الاستجابة. |
|
items[].id |
string |
معرّف واجهة برمجة التطبيقات هذه. |
|
items[].name |
string |
اسم واجهة برمجة التطبيقات. |
|
items[].version |
string |
إصدار واجهة برمجة التطبيقات. |
|
items[].title |
string |
عنوان واجهة برمجة التطبيقات هذه. |
|
items[].description |
string |
وصف واجهة برمجة التطبيقات هذه |
|
items[].discoveryRestUrl |
string |
عنوان URL لمستند الاكتشاف REST. |
|
items[].discoveryLink |
string |
رابط إلى مستند الاكتشاف. |
|
items[].icons |
object |
روابط إلى رموز 16×16 و32×32 تمثل واجهة برمجة التطبيقات. |
|
items[].icons.x16 |
string |
عنوان URL للرمز 16×16. |
|
items[].icons.x32 |
string |
عنوان URL للرمز 32×32. |
|
items[].documentationLink |
string |
رابط إلى المستندات البشرية التي يمكن قراءتها لواجهة برمجة التطبيقات. |
|
items[].labels[] |
list |
تصنيفات لحالة واجهة برمجة التطبيقات هذه، مثل limited_availability أو deprecated . |
|
items[].preferred |
boolean |
true إذا كانت هذه النسخة هي النسخة المفضّلة لاستخدامها. |
|
جرِّب هذه الميزة الآن.
استخدِم المستكشف أدناه لاستدعاء هذه الطريقة في البيانات المباشرة ومشاهدة الرد.
يمكنك بدلاً من ذلك تجربة
المستكشف
المستقل.
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2022-07-27 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2022-07-27 (حسب التوقيت العالمي المتفَّق عليه)"],[[["\u003cp\u003eThe \u003ccode\u003ediscovery.apis.list\u003c/code\u003e endpoint retrieves a list of all APIs supported by the Google APIs Discovery Service.\u003c/p\u003e\n"],["\u003cp\u003eEach API and its versions are represented as individual entries in the response.\u003c/p\u003e\n"],["\u003cp\u003eYou can filter results using optional parameters like \u003ccode\u003ename\u003c/code\u003e to include specific APIs or \u003ccode\u003epreferred\u003c/code\u003e to return only preferred versions.\u003c/p\u003e\n"],["\u003cp\u003eThe response provides comprehensive information about each API, including its ID, name, version, description, documentation link, and icons.\u003c/p\u003e\n"]]],[],null,["# Discovery Document: list\n\nRetrieve the list of APIs supported at this endpoint.\n\n\nThe `discovery.apis.list` method returns the list of all APIs supported by the\nGoogle APIs Discovery Service. The data for each entry is a subset of the Discovery Document\nfor that API, and the list provides a directory of supported APIs. If a specific API\nhas multiple versions, each of the versions has its own entry in the list.\n\nRequest\n-------\n\n### HTTP Request\n\n```\nGET https://discovery.googleapis.com/discovery/v1/apis\n```\n\n### Parameters\n\n| Parameter Name | Value | Description |\n|----------------|-----------|--------------------------------------------------------------------|\n| **Optional Parameters** |||\n| `name` | `string` | Only include APIs with the given name. |\n| `preferred` | `boolean` | Return only the preferred version of an API. \"`false`\" by default. |\n\n### Request Body\n\nDo not supply a request body with this method.\n\nResponse\n--------\n\nIf successful, this method returns a response body with the following structure:\n\n```text\n{\n \"kind\": \"discovery#directoryList\",\n \"discoveryVersion\": \"v1\",\n \"items\": [\n {\n \"kind\": \"discovery#directoryItem\",\n \"id\": string,\n \"name\": string,\n \"version\": string,\n \"title\": string,\n \"description\": string,\n \"discoveryRestUrl\": string,\n \"discoveryLink\": string,\n \"icons\": {\n \"x16\": string,\n \"x32\": string\n },\n \"documentationLink\": string,\n \"labels\": [\n string\n ],\n \"preferred\": boolean\n }\n ]\n}\n```\n\n| Property Name | Value | Description |\n|-----------------------------|-----------|------------------------------------------------------------------------------------|\n| `kind` | `string` | The fixed string discovery#directoryList |\n| `discoveryVersion` | `string` | Indicate the version of the Discovery API used to generate this doc. |\n| `items[]` | `list` | The individual directory entries. One entry per API/version pair. |\n| items[].`kind` | `string` | The kind for this response. |\n| items[].`id` | `string` | The ID of this API. |\n| items[].`name` | `string` | The name of the API. |\n| items[].`version` | `string` | The version of the API. |\n| items[].`title` | `string` | The title of this API. |\n| items[].`description` | `string` | The description of this API. |\n| items[].`discoveryRestUrl` | `string` | The url for the discovery REST document. |\n| items[].`discoveryLink` | `string` | A link to the discovery document. |\n| items[].`icons` | `object` | Links to 16x16 and 32x32 icons representing the API. |\n| items[].icons.`x16` | `string` | The url of the 16x16 icon. |\n| items[].icons.`x32` | `string` | The url of the 32x32 icon. |\n| items[].`documentationLink` | `string` | A link to human readable documentation for the API. |\n| items[].`labels[]` | `list` | Labels for the status of this API, such as `limited_availability` or `deprecated`. |\n| items[].`preferred` | `boolean` | `true` if this version is the preferred version to use. |"]]