שלב 6: פרסום API

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

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

בשלב הזה, תפרסמו API בפורטל על ידי ביצוע השלבים הבאים:

  1. יצירת שרת proxy ל-API ממפרט
  2. יצירת מוצר API
  3. פרסום ה-API בפורטל

שלב 1: יצירת API Proxy ממפרט

ליצור שרת proxy ל-API ממפרט OpenAPI שמתאר את ה-API.

כדי ליצור proxy ל-API ממפרט OpenAPI:

  1. במסוף Apigee ב-Cloud, עוברים לדף Proxy Development > API proxies.

    מעבר לשרתי proxy ל-API

  2. לוחצים על יצירה. נפתח האשף Create a proxy (יצירת שרת proxy) שבו צריך לבחור את סוג שרת ה-proxy של ה-API שרוצים ליצור.

  3. לוחצים בתיבה תבנית פרוקסי.

  4. לוחצים על תבנית של מפרט OpenAPI, שרת proxy הפוך (הנפוץ ביותר).

  5. פותחים את הקובץ הבא בדפדפן ושומרים אותו: 

    https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml

  6. בשלב 1: מפרטי OpenAPI, לוחצים על עיון.

  7. עוברים לקובץ OpenAPI Spec שהורדתם, בוחרים אותו ולוחצים על Open (פתיחה).

  8. לוחצים על הבא.

  9. בשלב 2: פרטי ה-Proxy, השדות מאוכלסים מראש בערכים מתוך מפרט OpenAPI. עורכים את השדה Description (תיאור) באופן הבא: proxy ל-API עבור hello world.

  10. לוחצים על הבא.

  11. בשלב 3 זרימות, בוחרים את כל הפעולות.

  12. לוחצים על הבא.

  13. בשלב 4: פריסה, בוחרים את הסביבה שרוצים לפרוס בה.

  14. לוחצים על OK.

  15. לוחצים על יצירה.

כשפורסים את ה-proxy ל-API, בעמודה Status בקטע Deployments מופיע סמל ירוק שמראה שהגרסה של ה-proxy ל-API נפרסה. כדי לראות מידע נוסף על הפריסה, אפשר להעביר את הסמן מעל סמל הסטטוס.

שלב 2: יצירת מוצר API

יוצרים מוצר API שמכיל את משאבי ה-API שרוצים לחשוף לצרכני ה-API.

כדי ליצור מוצר API:

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

    מעבר אל מוצרי API

  2. לוחצים על יצירה. יוצג הדף פרטי מוצר. מזינים את פרטי המוצר של מוצר ה-API.

    שדה ערך
    שם שלום עולם
    שם לתצוגה שלום עולם
    תיאור דוגמה פשוטה של 'שלום עולם'
    סביבה בוחרים את הסביבה שבה נפרס proxy ל-API.
    גישה גלוי לכולם
    אישור אוטומטי של בקשות גישה מופעל
    מכסה (משאירים ריק)
    היקפי הרשאות מותרים של OAuth (משאירים ריק)

  3. בקטע Operations (פעולות), לוחצים על Add an operation (הוספת פעולה) כדי לציין את הפעולות שרוצים להוסיף למוצר ה-API.

    • בקטע מקור, בוחרים באפשרות proxy ל-API ואז בוחרים באפשרות Mock-Target-API מהתפריט הנפתח.
    • בקטע Operation (פעולה), מזינים קו נטוי (/) בשדה Path (נתיב). מתעלמים משאר השדות.

  4. לוחצים על שמירה כדי לשמור את הפעולה.

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

שלב 3: פרסום ה-API בפורטל

מפרסמים את ה-API בפורטל כדי שהלקוחות יוכלו לקרוא עליו ולהשתמש בו.

כדי לפרסם את ה-API בפורטל:

  1. במסוף Apigee ב-Cloud, עוברים לדף Distribution > Portals.

    מעבר אל Portals

  2. לוחצים על השורה My first portal (הפורטל הראשון שלי) כדי לפתוח את הפורטל.

  3. לוחצים על הכרטיסייה APIs.

  4. לוחצים על + API.

  5. בקטע מוצר API בוחרים באפשרות Hello World.

  6. בוחרים באפשרות פורסם (מופיע בקטלוג) כדי לפרסם את ה-API בפורטל.

  7. בשדה Display title (שם לתצוגה), מזינים Hello World.

  8. בקטע תמונה לתצוגה, לוחצים על בחירה.

  9. לוחצים על נכסים.

  10. לוחצים על תצוגה מקדימה של home-background.jpg.

  11. לוחצים על בחירה.

  12. כדי ליצור אוטומטית מסמכי עזר ל-API מתוך תמונת מצב של מפרט OpenAPI, אפשר לעיין במאמרי העזרה בנושא API.

    1. בוחרים באפשרות מסמך OpenAPI.
    2. לוחצים על בחירה.
    3. לוחצים על הכרטיסייה כתובת URL.
    4. מקלידים helloworld בשדה Spec name (שם המפרט).
    5. מעתיקים את כתובת ה-URL הבאה ומדביקים אותה בשדה כתובת URL: 
      https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget3.0.yaml
    6. לוחצים על בחירה.

  13. לוחצים על Save.

שלב 4: הצגת מאמרי העזרה של ה-API

כדי לראות את מאמרי העזרה של ה-API:

  1. בממשק המשתמש של Apigee, לוחצים על Live Portal כדי לראות את השינויים בפורטל הפעיל (או מרעננים את הפורטל הפעיל אם הוא כבר פתוח בכרטיסייה אחרת).
  2. בפורטל השידור החי:
    1. בסרגל הניווט העליון לוחצים על APIs (ממשקי API) כדי לראות את ממשק ה-API שפורסם.
    2. לוחצים על הכרטיס Hello World כדי לראות את מאמרי העזרה של ה-API.
    3. כדאי לנסות את ה-API!

הדמיה של API לטירגוט שפורסם באמצעות החלונית Try this API