שלב 6: פרסום API

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X. מידע

בשלב הזה, תפרסמו API בפורטל על ידי ביצוע השלבים הבאים:
‫1. יוצרים מפרט OpenAPI
‫2. יצירת proxy ל-API ממפרט
‫3. יוצרים מוצר API
‫4. פרסום ה-API בפורטל

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

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

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

  1. בסרגל הניווט הימני, בוחרים באפשרות פיתוח > מפרטים כדי לפתוח את הדף מפרטים.
  2. לוחצים על + Spec > Import URL (‏+ Spec > ייבוא כתובת URL).
  3. בתיבת הדו-שיח של הייבוא, מזינים את הפרטים הבאים:
  4. שם הייבוא: helloworld

  5. כתובת URL של הייבוא: https://raw.githubusercontent.com/apigee/api-platform-samples/master/default-proxies/helloworld/openapi/mocktarget.yaml

  6. לוחצים על ייבוא.

שלב 2: יצירת שרת proxy של API ממפרט

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

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

  1. בדף המפרטים, מציבים את הסמן מעל המפרט helloworld כדי להציג את תפריט הפעולות.
  2. לוחצים על כדי ליצור proxy ל-API מהמפרט.
    נפתח האשף Build a Proxy ודף הפרטים מאוכלס מראש באמצעות ערכים מ-OpenAPI Specification.
  3. עורכים את השדה Description (תיאור) באופן הבא: proxy ל-API עבור hello world.
  4. לוחצים על הבא.

  5. בדף Policies:

    • בקטע Security: Authorization (אבטחה: הרשאה), בוחרים באפשרות Pass through (no authorization) (העברה ללא אישור).
    • בקטע אבטחה: דפדפן, בוחרים באפשרות הוספת כותרות CORS .

    דף המדיניות הנפוצות באשף ליצירת Proxy עם האפשרויות Pass through (העברה) ו-Add CORS headers (הוספת כותרות CORS)

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

  7. בדף זרימות, מוודאים שכל הפעולות נבחרו ולוחצים על הבא.
    יצירת רצפי פעולות של שרתי Proxy

  8. בדף 'מארחים וירטואליים', מוודאים שכל המארחים הווירטואליים נבחרו ולוחצים על הבא.

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

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

בדף הסיכום יופיע אישור לכך שנוצר proxy ל-API חדש ושהוא נפרס בסביבת הבדיקה.

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

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

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

  1. בסרגל הניווט הימני, בוחרים באפשרות פרסום > מוצרי API כדי לפתוח את הדף 'מוצרי API'.
  2. לוחצים על + מוצר API.
    מוצג הדף 'מוצר חדש'.
  3. מזינים את פרטי המוצר של מוצר ה-API.
    הערה: שדות השם המוצג והתיאור מוצגים בפורטל כשמפרסמים את מוצר ה-API, כברירת מחדל. אפשר לערוך את הערכים בשלב 4: פרסום ה-API בפורטל.
    שדה ערך
    שם שלום עולם
    השם המוצג שלום עולם
    תיאור דוגמה פשוטה של 'שלום עולם'
    סביבה בוחרים את הסביבה שבה נפרס proxy ל-API.
    גישה גלוי לכולם
    אישור אוטומטי של בקשות גישה מופעל
    מכסה (משאירים ריק)
    היקפי הרשאות מותרים של OAuth (משאירים ריק)
  4. בקטע API resources (משאבי API), לוחצים על Add a proxy (הוספת שרת proxy) כדי לזהות את שרתי ה-proxy ל-API שרוצים להוסיף למוצר ה-API.
    מופיעה תיבת הדו-שיח Add API Resource.
  5. לוחצים על API Proxy (אם היא לא נבחרה כבר) ובוחרים באפשרות Mock-Target-API ברשימה.
  6. לוחצים על הוספה.
  7. לוחצים על שמירה כדי לשמור את מוצר ה-API.

    מוצר API של Hello World עם כל השדות שמוגדרים

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

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

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

  1. עוברים לדף APIs בפורטל:
    1. בסרגל הניווט הימני, בוחרים באפשרות פרסום > פורטלים.
    2. לוחצים על השורה My first portal (הפורטל הראשון שלי) כדי לפתוח את הפורטל.
    3. לוחצים על API catalog כדי להציג את דף ממשקי ה-API.
  2. לוחצים על הסימן +.
  3. בתיבת הדו-שיח הוספת מוצר API לקטלוג, בוחרים באפשרות Hello World ולוחצים על הבא.
  4. בקטע פרטי ה-API, מגדירים את האפשרויות הבאות:
    • בוחרים באפשרות פורסם (מופיע בקטלוג) כדי לפרסם את ה-API בפורטל.
    • לגבי תמונה לתצוגה:
      1. לוחצים על בחירת תמונה.
      2. לוחצים על home-background.jpg ברשימת התמונות הקיימות בתיבת הדו-שיח בחירת תמונה.
      3. לוחצים על בחירה.
      4. רואים תצוגה מקדימה של התמונה ולוחצים על בחירה.
    • בקטע קטגוריות, מזינים קדימה, מתחילים ומקישים על Enter.

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

  5. בקטע מאמרי העזרה של ה-API, כדי ליצור באופן אוטומטי מאמרי העזרה של ה-API מקובץ snapshot של מפרט OpenAPI:
    1. בוחרים באפשרות מסמך OpenAPI.
    2. לוחצים על בחירת מסמך.
    3. בוחרים בכרטיסייה My Specs (אם היא לא נבחרה כבר).
    4. בוחרים באפשרות helloworld מתוך רשימת המפרטים.
    5. לוחצים על בחירה.
  6. לוחצים על שמירה כדי לשמור את פרטי ה-API.

    ‫Hello World API עם כל השדות שהוגדרו

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

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

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

מזל טוב! סיימתם את המדריך. מוכן לקבל מידע נוסף? עוברים אל יצירת פורטל משולב.