ב-Discovery API יש רשימה של ממשקי ה-API של Google לאחזור מטא נתונים כמו קריאה למחשבים
המסמך הזה מיועד למפתחים שרוצים לכתוב ספריות לקוח, יישומי פלאגין של IDE וכלים אחרים לאינטראקציה עם ממשקי API של Google.
רקע של שירות Discovery
מושגים
שירות Discovery של Google APIs מבוסס על שני עקרונות בסיסיים:
- ספריית ממשקי API: רשימה של כל ממשקי ה-API הנתמכים על ידי שירות Discovery Discovery. כל רשומה בספרייה מציגה פרטים על ממשק API נתמך, כולל השם שלו, תיאור קצר של מה שהוא עושה וקישור לתיעוד. ל-API יכולות להיות רשומות מרובות של הספרייה, אחת לכל אחת מהגרסאות הנתמכות.
- מסמך Discovery: תיאור שקריא למחשבים של ממשק API מסוים. מסמך ה-Discovery מתאר את פני השטח של גרסה מסוימת של ה-API. המסמך מספק פרטים על הגישה לשיטות השונות של כל API באמצעות קריאות ל-HTTP מסוג REST. מסמך Discovery כולל תיאורים של הנתונים והשיטות המשויכים ל-API, וגם מידע על ההיקפים הזמינים של OAuth ועל תיאורים של סכימות, שיטות, פרמטרים וערכי פרמטרים זמינים.
מודל נתונים
משאב הוא ישות נתונים נפרדת עם מזהה ייחודי. שירות Discovery של Google APIs פועל בשני סוגים של משאבים, בהתאם לקונספטים שצוינו.
רשימת ממשקי API: רשימת ממשקי API
כל רשומה בספרייה מכילה צמד של שם/גרסה של ה-API, עם הפרטים הבאים:
- פרטי זיהוי ותיאור,: שם, גרסה, כותרת ותיאור.
- פרטי התיעוד: סמלים וקישור לתיעוד.
- פרטי סטטוס, כולל תוויות סטטוס, וציון אם זו הגרסה המועדפת של ה-API.
- קישור למסמך Discovery, ה-URI של מסמך Discovery של ה-API הזה (מסופק ככתובת URL מלאה, למשל: https://servicemanagement.googleapis.com/$discovery/rest?version=v1).
משאב במסמך Discovery: תיאור שקריא למחשבים של ממשק API מסוים
בנוסף למידע שסופק בספריית ממשקי ה-API, מסמך Discovery כולל גם:
- סכימות. זוהי רשימה של סכימות משאבים ל-API שמתארות את הנתונים שיש לכם גישה אליהם בכל ממשק API. הסכימות של שירות Discovery של Google APIs מבוססות על סכימת JSON.
- שיטות, כולל רשימה של שיטות API ופרמטרים זמינים של כל שיטה.
- היקפי OAuth, המזהה את רשימת היקפי ההרשאות של OAuth שזמינים ל-API הזה.
- תיעוד מוטבע, שמספק תיאורים קצרים של סכימות, שיטות, פרמטרים וערכי פרמטרים זמינים.
אוסף ה-Directory Directory הוא מאגר קונספט של המשאב היחיד של ספריית ממשקי ה-API, והמשאבים של מסמך Discovery לכל API נתמך.
פרטים נוספים על המשאב של ספריית ממשקי ה-API ועל המשאב במסמך Discovery מפורטים במסמכים של שימוש ב-API ובחומר העזר.
פעולות
ניתן להפעיל שתי שיטות שונות לאוספים ולמשאבים בשירות הגילוי של Google APIs, כמתואר בטבלה הבאה.
| פעולה | תיאור | מיפויי HTTP ב-REST |
|---|---|---|
| list | רשימה של כל ממשקי ה-API הנתמכים. | GET ב-URI המשאב של הספרייה. |
סגנון שיחה
REST
הפעילות הנתמכת של פעולות ה-Discovery API בשירות Google Maps ממופה ישירות אל פועל REST HTTP GET, כמתואר בפעולות.
הפורמט הספציפי ל-URIs של שירות Discovery של Google APIs הוא:
https://discovery.googleapis.com/discovery/v1/apis?parameters
כאשר api הוא המזהה של משאב של מסמך Discovery, ו-version הוא המזהה של הגרסה הספציפית של ה-API, ו-_parameters_ הם פרמטרים שיחולו על השאילתה. לפרטים נוספים, אפשר לעיין בסיכום הפרמטרים של השאילתות בתיעוד העזר
פרטים על הקבוצה המלאה של מזהי URI המשמשים לכל פעולה נתמכת ב-API מסוכמים במסמך חומרה של Google APIs עבור שירות Discovery.
הנה כמה דוגמאות לאופן הפעולה של שירות Discovery של Google APIs.
רשימה של כל ממשקי ה-API הנתמכים של שירות Discovery של Google APIs:
GET https://discovery.googleapis.com/discovery/v1/apis
אפשר לנסות זאת עכשיו ב-APIs Explorer!
להורדת מסמך Discovery של Google Cloud Service Management API, גרסה 1:
GET https://servicemanagement.googleapis.com/$discovery/rest?version=v1