מסמך Discovery: רשימה
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
אחזור הרשימה של ממשקי ה-API הנתמכים בנקודת הקצה הזו.
כדאי לנסות עכשיו.
השיטה discovery.apis.list מחזירת את הרשימה של כל ממשקי ה-API הנתמכים על ידי שירות Google APIs Discovery. הנתונים של כל רשומה הם קבוצת משנה של מסמך Discovery עבור אותו 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 |
רשימת המחרוזת המתוקנת של Discover#directoryList |
|
discoveryVersion |
string |
יש לציין את גרסת ה-API של Discovery המשמשת ליצירת המסמך. |
|
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 |
כתובת ה-URL של מסמך ה-REST לגילוי. |
|
items[].discoveryLink |
string |
קישור למסמך הגילוי. |
|
items[].icons |
object |
קישורים לסמלים בגודל 16x16 ו-32x32 המייצגים את ה-API. |
|
items[].icons.x16 |
string |
כתובת ה-URL של הסמל בגודל 16x16. |
|
items[].icons.x32 |
string |
כתובת ה-URL של הסמל בגודל 32x32. |
|
items[].documentationLink |
string |
קישור לתיעוד אנושי לקריאה עבור ה-API. |
|
items[].labels[] |
list |
תוויות לסטטוס ה-API הזה, כמו limited_availability או deprecated. |
|
items[].preferred |
boolean |
true אם זו הגרסה המועדפת לשימוש. |
|
רוצה לנסות?
אפשר להשתמש בסייר שלמטה כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה.
לחלופין, אפשר
סייר עצמאי.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0 ודוגמאות הקוד הן ברישיון Apache 2.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2022-07-27 (שעון UTC).
[null,null,["עדכון אחרון: 2022-07-27 (שעון UTC)."],[[["\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. |"]]
