שלב 7: פריסה בסביבת Apigee

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

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

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

  1. פועלים לפי השלבים במאמר יצירת סביבה כדי לבצע את הפעולות הבאות:
    1. יוצרים סביבת פיתוח חדשה בארגון Apigee, ומפעילים את הארכיון כסוג הפריסה. משתמשים בממשק המשתמש או ב-API.
    2. מצרפים את הסביבה למופע של סביבת זמן ריצה באמצעות Instances attachment API.

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

    3. אם עדיין אין לכם קבוצת סביבות, אתם יכולים ליצור אותה באמצעות Create environment groups API.

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

      curl -i -H "$AUTH" -H "Content-Type:application/json" \
  "https://apigee.googleapis.com/v1/organizations/$PROJECT_ID/environments/ENVIRONMENT_NAME"
    4. מצרפים את הסביבה החדשה לקבוצת הסביבות באמצעות Environment group attachment API.

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

  2. פריסת ארכיון של הגדרות proxy ל-API בסביבת Apigee.
    1. בכרטיסייה Terminal ב-Apigee VS Code, עוברים לספרייה myapigeeworkspace. 
      cd myapigeeworkspace

      כשמריצים את הפקודה ls, הספרייה אמורה להכיל את התיקייה src.

    2. מריצים את הפקודה הבאה: 
      gcloud beta apigee archives deploy --environment=dev --labels=release=052021

      זוהי דוגמה לתשובה: 

      Using Apigee organization dev
Waiting for operation [b64c2665-b5ac-43cc-9e2d-232e8895c2ed] to complete...done
  3. כדי לבדוק את ה-API, מריצים את הפקודה הבאה בכרטיסייה Terminal: 
    curl https://INTERNAL_LOAD_BALANCER_IP/helloworld /
  -H "Host: ENV_GROUP_HOSTNAME"

    מידע נוסף על המשתנים בדוגמה הזו ועל הגדרת גישה ל-API זמין במאמר פריסת שרת proxy לדוגמה.

    מוצגת הודעת השגיאה הבאה: 

    {"fault":{"faultstring":"Failed to resolve API Key variable request.queryparam.apikey",
  "detail":{"errorcode":"steps.oauth.v2.FailedToResolveAPIKey"}}}

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

  4. מקבלים מפתח API.
    1. יוצרים מוצר API באמצעות ממשק המשתמש של Apigee:
      1. עוברים לדף מוצרי ה-API:

        במסוף Google Cloud , נכנסים לדף Distribution > API products.

        לדף API products

      2. לוחצים על ‎+ Create.
      3. מזינים את פרטי המוצר של ה-API.
      4. מזינים את הפרטים הבאים בשדות:
        שדה הגדרה
        Name: myproduct
        Display name: myproduct
        Environment: dev
        Access: גלוי לכולם
        Quota: להשאיר ריק
        Allowed OAuth scope: להשאיר ריק
      5. בקטע פעולות, לוחצים על + הוספת פעולה.
      6. בקטע מקור, בוחרים באפשרות helloworld מהתפריט הנפתח API Proxy.
      7. בקטע פעולה, בשדה 'נתיב', מזינים /.

        משאירים את שאר השדות בערכי ברירת המחדל.

      8. לוחצים על שמירה כדי לשמור את הפעולה.
      9. לוחצים על שמירה כדי לשמור את מוצר ה-API.
    2. יוצרים מפתח בארגון:

      1. במסוף Google Cloud , נכנסים לדף Distribution > Developers.

        מעבר אל 'מפתחים'

      2. לוחצים על ‎+ Create.
      3. מזינים את הפרטים הבאים בשדות:
        שדה הגדרה
        First Name: Alex
        Last Name: Hamilton
        Username: ahamilton
        Email: ahamilton@example.com
      4. לוחצים על הוספה.
    3. רישום אפליקציה:
      1. פותחים את כלי עריכת האפליקציות.

        1. במסוף Google Cloud , נכנסים לדף Distribution > Apps.

          מעבר אל 'אפליקציות'

        2. לוחצים על ‎+ Create.
      2. מזינים את הפרטים הבאים בשדות:
        שדה הגדרה
        Name: myapp
        Display name: myapp
        Developer: ahamilton@example.com
        Callback URL: להשאיר ריק
        Notes: להשאיר ריק
        Expiry: אף פעם
        Product:
        1. לוחצים על הוספת מוצר.
        2. בוחרים באפשרות myproduct.
        3. לוחצים על הוספה.
        Custom attributes: להשאיר ריק
      3. לוחצים על יצירה.
    4. מעתיקים את מפתח ה-API.

      1. במסוף Google Cloud , נכנסים לדף Distribution > Apps.

        מעבר אל 'אפליקציות'

      2. לוחצים על myapp.
      3. בקטע Credentials, ליד Key, לוחצים על Show.
      4. לוחצים על העתקה.
  5. מריצים שוב את קריאת ה-curl ומעבירים את מפתח ה-API באמצעות פרמטר השאילתה apikey, באופן הבא: 
    curl -v https://$PUBLIC_FACING_IP/helloworld?apikey=ZQA5euYtNeJ7ZCGCJMpvd6F2BZOmxOzY

    התגובה הבאה מוחזרת:

    {
  "root": {
    "city": "San Jose",
    "firstName": "John",
    "lastName": "Doe",
    "state": "CA"
  }
}

מזל טוב! פרסת בהצלחה את ארכיון ה-API בסביבת Apigee.

בשלב הבא, תקדמו את ארכיון ה-API לסביבת ייצור של Apigee.

1 2 3 4 5 6 7 (הבא) שלב 8: העברת ארכיון לסביבת ייצור