ניהול המפרטים שלך

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

ב-Apigee Edge ניתן לאחסן את המפרטים של OpenAPI. נהל את מפרטי OpenAPI כפי שמתואר בקטעים הבאים.

מידע נוסף על מפרטי OpenAPI זמין במאמר מהו מפרט OpenAPI?

לעיון ברשימת המפרטים

כדי לגשת לרשימת המפרטים:

1. נכנסים לאתר apigee.com/edge.
2. בחר ארגון.
3. בתפריט הניווט שבצד, בוחרים פיתוח > מפרטים.

תוצג הרשימה הנוכחית של המפרטים והתיקיות.

כפי שמודגש באיור הקודם, מתוך רשימת המפרטים ניתן:

• יצירה וimport של מפרטים
• יצירת שרת proxy של API ממפרט באמצעות אשף מרובה שלבים
• ארגון התוכן באמצעות תיקיות וניווט בתיקיות האלה (מידע נוסף זמין במאמר ארגון תוכן באמצעות תיקיות)
• עריכת מפרט או פתיחת תיקיה באמצעות לחיצה על שורה
• שינוי שם או מחיקה של מפרט
• חיפוש ברשימת המפרטים והתיקיות

יצירת מפרט OpenAPI חדש

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

1. בסרגל הניווט שבצד, לוחצים על פיתוח > מפרטים.
2. לוחצים על + מפרט.
3. לוחצים על מפרט חדש בתפריט הנפתח. עורך המפרטים ייפתח.
4. להחליף את המפרט לדוגמה בפרטים משלכם במפרט OpenAPI.
   כדאי לעיין בקטע יצירת מפרטים באמצעות עורך המפרטים.
5. לוחצים על Save (שמירה) כדי לשמור את המפרט.
6. כאשר מופיעה ההנחיה, מזינים שם למפרט.
7. לוחצים על שמירה.

ייבוא של מפרט OpenAPI

כדי לייבא מפרט OpenAPI:

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

עריכת מפרט OpenAPI קיים

כדי לפתוח מפרט OpenAPI קיים:

1. בסרגל הניווט שבצד, לוחצים על פיתוח > מפרטים.
2. ברשימת המפרטים, לוחצים על השורה שמשויכת למפרט.
3. עריכת המפרט בעורך המפרטים.
   כדאי לעיין בקטע יצירת מפרטים באמצעות עורך המפרטים.

יצירת שרת proxy ל-API ממפרט ברשימת המפרט

באמצעות Apigee Edge ניתן ליצור שרתי proxy של API ממפרטי OpenAPI שמעצבים ושומרים בעורך המפרטים. זה לא דורש רק כמה לחיצות פשוטות על יצירת שרת proxy של API ב-Apigee Edge, שבו הנתיבים, הפרמטרים, התהליכים המותנים ונקודות הקצה (endpoints) של היעד נוצרים באופן אוטומטי. לאחר מכן תוכלו להוסיף תכונות כמו אבטחת OAuth, הגבלת קצב של יצירת בקשות ושמירה במטמון.

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

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

1. בתפריט הניווט שבצד, בוחרים פיתוח > מפרטים.
2. אם נדרש, מנווטים לתיקייה שמכילה את המפרט של OpenAPI.
3. מציבים את הסמן במפרט OpenAPI שעבורו רוצים ליצור שרת proxy ל-API כדי להציג את תפריט הפעולות.
4. לוחצים על . אשף יצירת שרת ה-Proxy נפתח ודף הפרטים של שרת ה-Proxy מאוכלס מראש באמצעות ערכים מהמפרט OpenAPI, כפי שמוצג באיור הבא.
   
5. לוחצים על הבא.
6. מבצעים את השלבים הנותרים באשף 'יצירת שרת proxy', כפי שמתואר במאמר יצירת שרת proxy ל-API ממפרט של OpenAPI. (מתחילים משלב 8).

שינוי שם של מפרט

כדי לשנות שם של מפרט:

1. בתפריט הניווט שבצד, בוחרים פיתוח > מפרטים.
2. במקרה הצורך, מנווטים לתיקייה שמכילה את המפרט.
3. מציבים את הסמן מעל למפרט שרוצים לשנות את שמו כדי להציג את תפריט הפעולות.
4. לוחצים על .
5. עריכת שם המפרט.
6. לוחצים על שינוי שם כדי לשמור את השינויים, או על ביטול כדי לבטל.

העברת מפרט לתיקייה

ניתן לארגן את המפרטים בתיקיות כדי להקל על הניהול והאבטחה. כדי להעביר מפרט לתיקייה, אפשר לעיין במאמר ארגון מפרטים באמצעות תיקיות.

מחיקת מפרט

אפשר למחוק מפרט ממאגר הקבצים אם הוא לא נחוץ יותר או שהוא לא תקין.

כדי למחוק מפרט:

1. בתפריט הניווט שבצד, בוחרים פיתוח > מפרטים.
2. מציבים את הסמן מעל למפרט שרוצים למחוק כדי להציג את תפריט הפעולות.
3. לוחצים על .
4. לוחצים על מחיקה כדי לאשר את פעולת המחיקה שמופיעה בהודעה.
5. מוחקים פריטים קשורים שאינם נחוצים יותר.