שלב 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.

הערה: בדוגמאות שבקטע הזה נעשה שימוש בערך 0 עבור המארח ובערך 8998 עבור היציאה. אפשר להגדיר את ערכי היציאות, כמו שמתואר במאמר ניהול האמולטור של Apigee. אם מופיעה שגיאה כשמשתמשים ב-0, מחליפים את 0 ב-localhost:

curl localhost:8998/helloworld

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

יצירת חבילת בדיקה:
1. ממקמים את הסמן מעל התיקייה test data ולוחצים על .
  
  ייפתח האשף Create test bundle (יצירת חבילת בדיקה).
2. מזינים mytestbundle בתור שם חבילת הבדיקה ומקישים על Enter.
  חבילת הבדיקה נוצרת.
3. מרחיבים את התיקייה mytestbundle כדי לראות את התוכן שלה.
מגדירים את משאב הבדיקה של מוצר ה-API:
1. מעבירים את הסמן מעל הקובץ products.json ולוחצים על .
  
  נפתח האשף Create API product (יצירת מוצר 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"
    ]
  }
]
```
מגדירים את משאב הבדיקה למפתחים:
1. מציבים את הסמן מעל הקובץ developers.json ולוחצים על .
  
  ייפתח האשף Create developer.
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"
    }
  ]
```
מגדירים את משאב הבדיקה של אפליקציית הפיתוח:
1. מציבים את הסמן מעל הקובץ developerapps.json ולוחצים על .
  
  ייפתח האשף Create developer app (יצירת אפליקציה למפתחים).
2. בוחרים את ahamilton@example.com כבעלים של האפליקציה.
3. מזינים את הערכים הבאים בהנחיות הבאות ולוחצים על Enter כדי לאשר ולהמשיך:
  - שם האפליקציה: myapp
  - תיאור: myapp
  - כתובת אתר של קריאה חוזרת (callback): משאירים ריק
  - בוחרים באפשרות myproduct כדי להוסיף אותה לאפליקציה ולוחצים על OK.
  - בוחרים באפשרות אף פעם בתור ערך התפוגה.
  קובץ 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"
  }
]
```
מייצאים את משאבי הבדיקה לאמולטור Apigee.
מציבים את הסמן מעל חבילת הבדיקה mytestbundle ולוחצים על .

הערה: אם פועלים כמה מאגרי תגים של Apigee Emulator, תתבקשו לבחור את מאגר התגים שאליו תרצו לפרוס את הסביבה.

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

קבלת מפתח ה-API

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

בקטע emulators (אמולטורים), מתחת לActive test data (נתוני בדיקה פעילים), לוחצים על Active developer apps (אפליקציות פעילות למפתחים).
קובץ התצורה של אפליקציות המפתחים הפעילות ייפתח בעורך. הקובץ מכיל פרטי כניסה ל-myproduct, כפי שמודגש באיור הבא.
מעתיקים את הערך consumerKey (ללא המירכאות) של מוצר ה-API‏ myproduct.

בדיקת ה-API

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

מעבירים את מפתח ה-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