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

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

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

5. בדף מדיניות:

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

   

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

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

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

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

   

10. לוחצים על Create.

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

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

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

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

1. בסרגל הניווט הימני בוחרים באפשרות פרסום > מוצרי API כדי לפתוח את הדף 'מוצרי API'.
2. לוחצים על + מוצר API.
   הדף 'מוצר חדש' מוצג.
3. מזינים את פרטי המוצר של מוצר ה-API.
   הערה: כברירת מחדל, השדות 'שם תצוגה' ו'תיאור' מוצגים בפורטל כשמפרסמים את מוצר ה-API. אפשר לערוך את הערכים בשלב 4: פרסום ה-API בפורטל שלך.
   

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

4. בקטע משאבי API, לוחצים על הוספת שרת proxy כדי לזהות את שרתי ה-proxy של ה-API להוספה למוצר ה-API.
   תופיע תיבת הדו-שיח Add API Resource.
5. לוחצים על API Proxy (אם הוא עדיין לא מסומן) ובוחרים באפשרות Mock-Target-API ברשימה.
6. לוחצים על Add.
7. לוחצים על Save (שמירה) כדי לשמור את מוצר ה-API.

   

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

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

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

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

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

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

   

כדי להציג את מסמכי התיעוד של ממשק ה-API:

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

---

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