מילון מונחים
בדף הזה מופיעות הגדרות קצרות וקישורים למידע נוסף על מונחים שמופיעים במסמכי התיעוד של API Gateway.
- API
- ממשק REST שמקל על אפליקציה אחת לצרוך יכולות או נתונים מאפליקציה אחרת. על ידי הגדרה של נקודות כניסה יציבות, פשוטות ומתועדות היטב, ממשקי API מאפשרים למפתחים לגשת בקלות ללוגיקה של אפליקציות שנבנו על ידי מפתחים אחרים ולעשות בה שימוש חוזר.
- API config
- נוצר כשמעלים הגדרת API ל-API Gateway. בכל פעם שמעלים הגדרת API, API Gateway יוצר הגדרת API חדשה. כלומר, אפשר ליצור הגדרת API אבל אי אפשר לשנות אותה מאוחר יותר. אם עורכים את הגדרת ה-API ואז מעלים את הגדרת ה-API הערוכה, נוצרת הגדרת API חדשה.
- הגדרת API
- מפרט Open API 2.0 או הגדרת gRPC שמשמשים ליצירת הגדרת API. הגדרת API מציינת: כתובת ה-URL של שירות לקצה העורפי, פורמט הנתונים של הנתונים שמועברים בבקשה, פורמט הנתונים של כל הנתונים שמוחזרים על ידי השירות, מנגנון האימות שמשמש לשליטה בגישה לשירות ועוד הרבה אפשרויות.
- מפתח API
- קוד שמועבר על ידי אפליקציית לקוח כשהיא קוראת ל-API. מפתחות API מזהים את האפליקציה או את הפרויקט ששולחים את הקריאה ל-API. Google Cloud מידע נוסף על שימוש במפתח API עם API של API Gateway זמין במאמר למה ומתי כדאי להשתמש במפתחות API.
- Auth0
- שירות שמאפשר להגדיר איך משתמשים מבצעים אימות באפליקציות. מידע נוסף זמין במאמר בנושא Auth0.
- CORS
- שיתוף משאבים בין מקורות (CORS) הוא מפרט שמספק דרך לאפליקציות אינטרנט לגשת למשאבים בשרת בדומיין אחר (מבחינה טכנית, במקור אחר). מידע נוסף על CORS זמין בתיעוד האינטרנט של Mozilla Developer Network (MDN) ובתקן Fetch Living.
- אימות ב-Firebase
- שירות האימות של Google שתומך בכניסה של משתמשי קצה לאפליקציות לקוח באמצעות פרטי כניסה מספקי זהויות פדרטיביים פופולריים כמו Google, Facebook או Twitter. למידע נוסף, אפשר לעיין במאמר בנושא אימות ב-Firebase.
- Gateway
- פרוקסי מבוסס Envoy, בעל ביצועים גבוהים וניתן להתאמה לעומס, שמארח את הגדרת ה-API שנפרסה. יצירת שער יוצרת את כתובת ה-URL שמופנית כלפי חוץ, שבה לקוחות ה-API משתמשים כדי לגשת ל-API. שער יכול לארח רק הגדרת API אחת. אי אפשר לפרוס כמה הגדרות API לאותו שער.
- טוקן של מזהה Google
- JSON Web Token (JWT) שמכיל את השדות של OpenID Connect שנדרשים לזיהוי של חשבון משתמש או חשבון שירות ב-Google, וחתום על ידי שירות האימות של Google,
https://accounts.google.com. - gRPC
- RPC היא מסגרת אוניברסלית בקוד פתוח שפותחה על ידי Google ומאפשרת ביצועים גבוהים. ב-gRPC, אפליקציית לקוח יכולה להפעיל ישירות שיטות באפליקציית שרת במכונה אחרת, כאילו מדובר באובייקט מקומי. מידע על שימוש ב-gRPC עם API Gateway ומידע כללי זמין בסקירה הכללית על gRPC ובאתר gRPC.
- JWT
- JSON Web Token הוא פורמט אסימון גישה בתקן פתוח לשימוש בכותרות הרשאות HTTP ובפרמטרים של שאילתות URI. מידע כללי זמין במאמר מבוא ל-JSON Web Tokens.
- OpenAPI
- יוזמת Open API היא מאמץ כלל-תעשייתי לתקנן את התיאור של ממשקי API ל-REST. ממשקי API שמתוארים באמצעות מפרט OpenAPI (לשעבר מפרט Swagger) יכולים לקבל תמיכה באמצעות כלים נפוצים שיוצרים תיעוד, מבצעים בדיקות אוטומטיות ומפיקים קוד ללקוחות ולשרתים. מידע נוסף זמין בסקירה הכללית על OpenAPI.
- מסמך OpenAPI
- קובץ בפורמט YAML או JSON שמשמש לתיאור ה-API. הקובץ הזה נקרא גם הגדרת API. כשמעלים את מסמך ה-OpenAPI אל API Gateway, הוא מומר להגדרת API.
- Surface
- הממשק הציבורי של API. המשטח של API מורכב מהשיטות, מהפרמטרים ומסוגי ההחזרה שמשמשים בשיטות.