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

אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info

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

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

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

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

  1. בוחרים באפשרות פיתוח > מפרט בסרגל הניווט הימני כדי לפתוח את הדף מפרט.
  2. לוחצים על + מפרט > ייבוא כתובת 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.
  3. עורכים את השדה Description באופן הבא: API proxy for hello world.
  4. לוחצים על הבא.

  5. בדף Policies:

    • בקטע אבטחה: הרשאה, בוחרים באפשרות מעבר ישיר (ללא הרשאה).
    • בקטע אבטחה: דפדפן, בוחרים באפשרות הוספת כותרות CORS .

    הדף Common policies (מדיניות נפוצה) באשף Create Proxy (יצירת שרת proxy), כאשר האפשרויות Pass through (מעבר דרך) ו-Add CORS headers (הוספת כותרות CORS) מסומנות

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

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

  8. בדף Virtual Hosts (מארחים וירטואליים), מוודאים שכל המארחים הווירטואליים מסומנים ולוחצים על Next (הבא).

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

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

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

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

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

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

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

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

שלב 4: מפרסמים את ה-API בפורטל

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

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

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

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

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

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

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

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

פרסום API לטירגוט מדומה באמצעות החלונית 'ניסיון של ה-API הזה'

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