תחילת השימוש ב-API Gateway וב-API hub

במדריך הזה נסביר איך לחבר את API Gateway ל-API Hub כדי לאפשר פרסום חלק של מטא-נתוני API מפרויקט API Gateway ל-API Hub.

במדריך הזה נשתמש במסוף Google Cloud .

רשימת המשימות

אפשר להשתמש ברשימת המשימות הבאה במהלך העבודה עם המדריך. כדי לחבר את API Gateway ל-API Hub, צריך לבצע את כל המשימות.

  1. מבצעים את השלבים המקדימים שמתוארים בקטע לפני שמתחילים.

  2. פריסת API ב-API Gateway.

  3. איך מקשרים את הפרויקט של API Gateway אל API Hub

  4. הצגת ה-API של API Gateway במרכז ה-API

  5. איך רואים את שער ה-MCP ב-API Hub

  6. כדי להימנע מחיובים בחשבון Google Cloud. מידע נוסף זמין במאמר בנושא הסרת המשאבים.

לפני שמתחילים

לפני שמתחילים, צריך לבצע את השלבים הבאים:

  1. הגדרת API Gateway בפרויקט.

  2. הגדרת API Hub בפרויקט המארח

הגדרת API Gateway בפרויקט

כדי להגדיר את API Gateway בפרויקט, מבצעים את הפעולות הבאות:

  1. נכנסים לדף API Gateway במסוף Google Cloud .

    ל-API Gateway

  2. כדי להשתמש ב-API Gateway, צריך להפעיל את שירותי Google הבאים:

    שם כותרת
    apigateway.googleapis.com API Gateway API
    servicemanagement.googleapis.com Service Management API
    servicecontrol.googleapis.com Service Control API

    אם לא הפעלתם בעבר את השירותים האלה בפרויקט שבחרתם, תתבקשו לעשות זאת.

  3. מוודאים שהחיוב מופעל בפרויקט.

    איך מפעילים את החיוב

הגדרה של API Hub בפרויקט המארח

  1. יוצרים או בוחרים Google Cloud פרויקט שישמש כפרויקט המארח.

    פרויקט מארח הוא פרויקט ב Google Cloud ארגון שלכם ב- Google Cloud , שאתם מגדירים כפרויקט הצרכן של כל המשאבים ב-API Hub. אפשר להקצות מופע אחד של API Hub לכל פרויקט מארח.

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

  2. הקצאת תפקידים בניהול זהויות והרשאות גישה (IAM) שנדרשים לחיבור של API Gateway ל-API Hub.

  3. הקצאת API hub בפרויקט המארח.

פריסת API ב-API Gateway

כדי לפרוס שירות Cloud Run מסוג "hello world" וליצור שער שמפנה לשירות הזה, צריך להשלים את המדריך למתחילים בנושא API Gateway.

לדוגמה, ה-API‏ helloworld נפרס ב-API Gateway‏ helloworld-gateway, כפי שמוצג בדף Gateways במסוף Google Cloud .

‫helloworld API מתארח בשער helloworld-gateway

צירוף פרויקט API Gateway ל-API Hub

כדי לצרף את פרויקט API Gateway ל-API Hub:

  1. נכנסים לדף API hub במסוף Google Cloud .

    כניסה ל-API Hub

  2. בתפריט הנפתח בוחרים את פרויקט המארח של API Hub.
  3. בתפריט הניווט הימני, לוחצים על הגדרות כדי לפתוח את הדף הגדרות.
  4. עוברים לכרטיסייה שיוכים לפרויקט.
  5. לוחצים על Attach runtime project (צירוף פרויקט זמן ריצה).
    בחלונית Select a resource (בחירת מקור מידע) שמופיעה,
  6. לוחצים על Google Cloud הפרויקט שבו הוקצה API Gateway.
  7. בחלונית Project association settings (הגדרות שיוך פרויקט), בוחרים באפשרות API Gateway (שער API) ובנכסי API אחרים שרוצים לייבא באופן אוטומטי.
  8. לוחצים על Save.

פרויקט זמן הריצה מצורף ומוצג ברשימה של פרויקטים מצורפים של זמן ריצה במסוף Google Cloud .

לדוגמה:

הפרויקט myproject מצורף כפרויקט זמן ריצה במרכז API

צפייה ב-API של API Gateway במרכז ה-API

כדי להציג את ה-API של API Gateway במרכז ה-API, מבצעים את הפעולות הבאות:

  1. במסוף Google Cloud , עוברים לדף APIs ב-API hub.

    כניסה ל-API Hub

  2. מאתרים את ה-API 'hello world' שפרסתם ב-API Gateway.

    אם צריך, בוחרים באפשרות Gateway: API Gateway בתפריט הנפתח Filter כדי להציג רק את ממשקי ה-API של API Gateway.

    לדוגמה:

    ממשק ה-API helloworld מוצג בדף APIs במרכז

  3. לוחצים על ה-API כדי לראות פרטים נוספים, כולל מטא-נתונים של ה-API.

הצגת שער ה-MCP במרכז ה-API

אם ה-API שלכם ב-API Gateway מוגדר כשרת Model Context Protocol‏ (MCP),‏ API Hub מוסיף לו רשומה שנייה בשם <your-api> (MCP). מידע נוסף זמין במאמר גילוי באמצעות API Hub ו-Agent Registry בסקירה הכללית של MCP.

רק שערים שמופעל בהם MCP יציגו את הרשומות הנוספות האלה במרכז ה-API.

כדי לראות את פרטי שער ה-MCP ב-API Hub:

  1. במסוף Google Cloud , עוברים לדף APIs ב-API hub.
  2. מחפשים את הרשומה בשם <your-api> (MCP).
  3. לוחצים על ה-API כדי לראות את הפרטים שלו, כולל מטא-נתונים וכלים ספציפיים ל-MCP.

לדוגמה, ממשק ה-API‏ helloworld (MCP) מוצג לצד ממשק ה-API הרגיל‏ helloworld במרכז ה-API:

ממשקי API של helloworld ו-helloworld (MCP) ב-API hub

אפשר גם לראות את שרת ה-MCP הזה ב-Agent Registry. הסוכנים יכולים לגלות את השרת ואת הכלים שלו באופן אוטומטי דרך הקטלוג.

לדוגמה, שרת ה-MCP מוצג בכרטיסייה MCP Servers ב-Agent Registry:

שרתי MCP ב-Agent Registry

הסרת המשאבים

כדי להימנע מחיובים בחשבון Google Cloud על המשאבים שבהם השתמשתם במדריך הזה, אתם יכולים:

אפשר גם למחוק את Google Cloud הפרויקטים שבהם השתמשתם במדריך הזה.

המאמרים הבאים