הגדרת ניהול API ב-Apigee ב-Cloud Code ל-VS Code

הדף הזה רלוונטי ל-Apigee ול-Apigee Hybrid.

לעיון במסמכי התיעוד של Apigee Edge

בדף הזה מוסבר איך ליצור סביבת פיתוח מקומית לניהול API ב-Apigee ב-Cloud Code ל-VS Code. במאמר סקירה כללית של פיתוח מקומי באמצעות Apigee מפורטות התכונות בסביבת הפיתוח המקומית.

תהליך ההגדרה מחייב השלמה של שני הקטעים במדריך הזה:

בהתאם לתרחישי השימוש, כדאי גם לבצע את השלבים במאמר הגדרת פיתוח של שרתי proxy ל-API לפיתוח מקומי ב-Apigee.

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

כדי להגדיר את Apigee ולהשתמש בו ב-VS Code, צריך:

  1. פרויקט Google Cloud להתחברות אליו בסביבת הפיתוח המקומית. צריך להקצות את הפרויקט ל-Apigee כדי ליצור סביבת עבודה מקומית של Apigee שבה אפשר לפתח ולבדוק שרתי proxy של API.
  2. (מומלץ) Apigee API hub שהוקצה בפרויקט. שילוב של API Hub מאפשר לכם לגשת לממשקי API ולערוך אותם בכל האקוסיסטם שלכם מתוך Cloud Code. בנוסף, נדרש API Hub כדי ליצור שרת מוק מרחוק לבדיקת מפרטי API.

    אם לא רוצים להוסיף את API Hub לפרויקט, אפשר לשייך את הפרויקט לפרויקט אחר שבו API Hub מופעל. במאמר צירוף פרויקט זמן ריצה למרכז API מוסבר איך לצרף פרויקט למרכז API.

    במאמר תפקידים שנדרשים לשימוש ב-API Hub עם פיתוח מקומי ב-Apigee מפורטות הפעולות שאתם מתכננים לבצע.
  3. הכרת VS Code, ניהול VS Code וביצוע פעולות נפוצות כמו גישה להגדרות והתקנת תוספים. מידע נוסף על VS Code

התפקידים הנדרשים לשימוש ב-Apigee API hub עם פיתוח מקומי ב-Apigee

כדי לבצע את השלבים של עיצוב ובדיקה של API באמצעות ממשקי ה-API של Apigee API hub, תצטרכו את התפקידים שמפורטים בהמשך:

משימה תפקידים נדרשים
הצגה ועריכה של ממשקי API ב-API Hub Cloud API Hub Admin או Cloud API Hub Editor
פרסום ממשקי API ב-API Hub Cloud API Hub Admin או Cloud API Hub Editor
הגדרה וניהול של שרת מוק מרוחק לבדיקת ממשקי API אדמין של Artifact Registry
חשבון שירות של Cloud Build
אדמין של Cloud Run
אדמין של Service Usage

ראו הפניה לתפקידים בסיסיים ומוגדרים מראש של ניהול זהויות והרשאות גישה (IAM).

צריך גם להתקין את Google Cloud CLI.

התקנה של VS Code והתוסף Cloud Code

בקטע הזה מוסבר איך להתקין את VS Code ואת התוסף Cloud Code ב-VS Code. זהו השלב הראשון בהגדרת פיתוח מקומי ל-Apigee, והוא נדרש כדי להשתמש בכל אחת מהתכונות של פיתוח מקומי ב-Apigee.

כדי להתקין את VS Code ואת התוסף Cloud Code:

  1. מורידים ומתקינים את Visual Studio Code (VS Code) במחשב המקומי, אם הוא עדיין לא מותקן.
  2. מתקינים את התוסף של Cloud Code, כמו שמתואר במאמר התקנת התוסף של Cloud Code. אם אתם מתכננים לנהל שרתי proxy ל-API בסביבה המקומית, תצטרכו להתקין את Docker כחלק מהתהליך.
  3. (מומלץ) מפעילים עדכונים אוטומטיים לתוסף Cloud Code. בקטע הגדרות, מחפשים את האפשרות Extensions: Auto Update ומפעילים אותה לכל התוספים או לתוסף Cloud Code בנפרד.
  4. מפעילים מחדש את VS Code.

הגדרת פיתוח של proxy ל-API ב-Apigee פיתוח מקומי

כדי להשתמש בסביבת הפיתוח המקומית לפיתוח ולבדיקה של proxy ל-API של Apigee, צריך לבצע את השלבים שמפורטים בקטע הזה. כדי ליצור proxy ל-API ממפרט OpenAPI, צריך גם לבצע את השלבים הבאים.

  1. יצירת סביבת עבודה של Apigee.
  2. מתקינים את Apigee Emulator.
  3. מוסיפים מאגר תגים לפריסה ב-Apigee Emulator.

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

אחרי שמסיימים את שלבי ההתקנה וההגדרה, אפשר להתחיל להשתמש ב-Cloud Code: