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

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

ב-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 עם הנתיבים, הפרמטרים, התהליכים המותנים ונקודות הקצה של היעד שנוצרו באופן אוטומטי. לאחר מכן תוכלו להוסיף תכונות כמו אבטחת OAuth, הגבלת קצב שליחת הבקשות ואחסון במטמון.

אחרי שיוצרים שרת proxy ל-API ממפרט OpenAPI, אם המפרט משתנה, צריך לשנות את שרת ה-proxy ל-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. לוחצים על Rename כדי לשמור את השינויים או על Cancel כדי לבטל.

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

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

מחיקת מפרט

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

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

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