מסמך 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 אם זו הגרסה המועדפת לשימוש.

רוצה לנסות?

אפשר להשתמש בסייר שלמטה כדי לקרוא לשיטה הזו בנתונים בזמן אמת ולראות את התגובה. לחלופין, אפשר סייר עצמאי.