שלב 4: בדיקת ה-API

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

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

כדי לבדוק את helloworld API שפרסתם, לוחצים על הכרטיסייה Terminal ב-Apigee ב-Cloud Code ומזינים את קריאת ה-curl הבאה:

curl 0:8998/helloworld

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

קריאה ל-API בכרטיסיית מסוף וקבלת שגיאת הרשאה

מכיוון שהפעלתם אימות מבוסס מפתח API כשיצרתם את ה-proxy ל-API, אתם צריכים להעביר מפתח API באמצעות פרמטר השאילתה apikey כשאתם קוראים ל-API.

כדי לקבל מפתח API, צריך ליצור חבילת בדיקה ולהגדיר את משאבי הבדיקה הבאים:

  • מוצר API שמשמש לאריזת ה-API ולהפיכתו לזמין למפתחים.

  • מפתח שיצור אפליקציה כדי לגשת ל-API.

  • אפליקציה למפתחים שתאפשר גישה ל-API באמצעות מפתח API.

פיתוח וייצוא של משאבי בדיקה

  1. יצירת חבילת בדיקה:
    1. ממקמים את הסמן מעל התיקייה test data ולוחצים על יצירת סמל לחבילת בדיקה.

      הסימן + מוצג כשמציבים את הסמן מעל התיקייה tests

      ייפתח האשף Create test bundle (יצירת חבילת בדיקה).

    2. מזינים mytestbundle בתור שם חבילת הבדיקה ולוחצים על Enter.

      חבילת הבדיקה נוצרת.

    3. מרחיבים את התיקייה mytestbundle כדי לראות את התוכן שלה.

      תיקיית בדיקה עם הקבצים developerapps.json,‏ developers.json,‏ maps.json ו-products.json

  2. מגדירים את משאב הבדיקה של מוצר ה-API:
    1. מעבירים את הסמן מעל הקובץ products.json ולוחצים על יצירת סמל של מוצר API.

      הסימן + מוצג כשמציבים את הסמן מעל products.json

      נפתח האשף Create API product (יצירת מוצר API).

      הדף הראשון באשף ליצירת מוצר API

    2. מזינים myproduct כשם של מוצר ה-API ומקישים על Enter כדי לאשר ולהמשיך.
    3. מזינים myproduct כתיאור של מוצר ה-API ומקישים על Enter כדי לאשר ולהמשיך.
    4. בוחרים באפשרות helloworld כדי להוסיף את proxy ל-API למוצר ה-API ולוחצים על OK.

      קובץ products.json נפתח בכלי העריכה עם מוצר ה-API החדש שהוגדר:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "scopes": [],
          "environments": [],
          "apiResources": [
            "/",
            "/*",
            "/**"
          ],
          "quota": "100",
          "quotaInterval": "1",
          "quotaTimeUnit": "minute",
          "name": "myproduct",
          "displayName": "myproduct",
          "proxies": [
            "helloworld"
          ]
        }
      ]
  3. מגדירים את משאב הבדיקה למפתחים:
    1. מציבים את הסמן מעל הקובץ developers.json ולוחצים על יצירת סמל מפתח Apigee.

      ‫+ מוצג כשמציבים את הסמן מעל developers.json

      ייפתח האשף Create developer.

      הדף הראשון באשף ליצירת מוצר API

    2. מזינים את הערכים הבאים בהנחיות ולוחצים על Enter כדי לאשר ולהמשיך:
      • כתובת האימייל של המפתח: ahamilton@example.com
      • שם משתמש: ahamilton
      • שם פרטי: Alex
      • שם משפחה: Hamilton

      קובץ developers.json נפתח בכלי העריכה עם המפתח החדש שהוגדר:

      [
          {
            "attributes": [
              {
                "name": "sample_attribute_0",
                "value": "sample_attribute_value_0"
              }
            ],
            "email": "ahamilton@example.com",
            "userName": "ahamilton",
            "firstName": "Alex",
            "lastName": "Hamilton"
          }
        ]
  4. מגדירים את משאב הבדיקה של אפליקציית הפיתוח:
    1. מציבים את הסמן מעל הקובץ developerapps.json ולוחצים על יצירת סמל אפליקציה למפתחים.

      ‫+ מוצג כשמציבים את הסמן מעל developerapps.json

      נפתח האשף Create developer app (יצירת אפליקציה למפתחים).

      הדף הראשון באשף ליצירת מוצר API

    2. בוחרים את ahamilton@example.com כבעלים של האפליקציה.
    3. מזינים את הערכים הבאים בהנחיות הבאות ולוחצים על Enter כדי לאשר ולהמשיך:
      • שם האפליקציה: myapp
      • תיאור: myapp
      • כתובת URL להתקשרות חזרה: משאירים את השדה ריק
      • בוחרים באפשרות myproduct כדי להוסיף אותה לאפליקציה ולוחצים על אישור.
      • בוחרים באפשרות אף פעם כערך התפוגה.

      קובץ developerapps.json נפתח בכלי העריכה עם האפליקציה החדשה שהוגדרה:

      [
        {
          "attributes": [
            {
              "name": "sample_attribute_0",
              "value": "sample_attribute_value_0"
            }
          ],
          "developerEmail": "ahamilton@example.com",
          "name": "myapp",
          "displayName": "myapp",
          "callbackUrl": "",
          "apiProducts": [
            "myproduct"
          ],
          "expiryType": "never"
        }
      ]
  5. מייצאים את משאבי הבדיקה אל Apigee Emulator.

    מציבים את הסמן מעל חבילת הבדיקה mytestbundle ולוחצים על סמל ייצוא משאבי הבדיקה.

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

    המשאבים הפעילים של הבדיקה מופיעים בקטע Apigee Emulators (אמולטורים של Apigee), כמו שמוצג באיור הבא.

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

קבלת מפתח ה-API

מקבלים את פרטי הכניסה של מפתח ה-API לאפליקציית המפתחים:

  1. בקטע emulators, מתחת לActive test data, לוחצים על Active developer apps.

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

    אפליקציות למפתחים עם הערך consumerKey מודגש.
  2. מעתיקים את הערך consumerKey (ללא המירכאות) של מוצר ה-API‏ myproduct.

בדיקת ה-API

בודקים את ה-API באמצעות מפתח ה-API:

  1. מעבירים את מפתח ה-API בקריאת ה-curl באמצעות פרמטר השאילתה apikey, באופן הבא:
    curl 0:8998/helloworld?apikey=API_KEY

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

    Hello, Guest!

מזל טוב! הפעלת בהצלחה API בסביבה המקומית.

בשלב הבא נסביר איך לשנות את נקודת הקצה של היעד.

1 2 3 4 (NEXT) Step 5: Change the target endpoint 6 7 8