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

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

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

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

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

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

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

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

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

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

יצירה של מפרט OpenAPI חדש

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

1. בסרגל הניווט הצדדי, לוחצים על פיתוח > מפרטים.
2. לוחצים על + מפרט.
3. בתפריט הנפתח, לוחצים על New Spec (מפרט חדש). ייפתח הכלי לעריכת המפרט.
4. מחליפים את המפרט לדוגמה בפרטים של מפרט OpenAPI שלכם.
   אפשר להיעזר במאמר בנושא יצירת מפרטים באמצעות כלי עריכת המפרטים.
5. לוחצים על שמירה כדי לשמור את המפרט.
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, הגבלת קצב וקירור מטמון.

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

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

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

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

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

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

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

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

מחיקת מפרט

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

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

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