אתם צופים במסמכי העזרה של Apigee Edge.
כניסה למסמכי העזרה של Apigee X. info
יצירת מפרטי OpenAPI ואימות שלהם בלי לכתוב קוד באמצעות עורך המפרטים.
גישה לעורך המפרט
פותחים מפרט OpenAPI בכלי לעריכת מפרטי OpenAPI, כפי שמתואר בקטעים הבאים:
באיור הבא מוצג המפרט של Petstore API שנפתח בעורך המפרטים:
כפי שמודגש באיור הקודם, עורך המפרט מאפשר לכם:
- יוצרים את מפרט OpenAPI כדי ליצור מודל ל-API באמצעות פורמט JSON או YAML בחלונית הימנית.
- הצגת תיעוד ה-API שנוצר באופן אוטומטי בחלונית השמאלית.
- מאמתים את המפרט בהתאם לסטנדרט של מפרט OpenAPI בזמן ההקלדה.
- שומרים את מפרט OpenAPI או סוגרים את המפרט ומבטלים את העריכות.
עזרה בנושא JSON ו-YAML
JSON (ראשי תיבות של JavaScript Object Notation) הוא פורמט קל להחלפת נתונים, המשמש לייצוג של מבני נתונים פשוטים ומערכים אסוסיאיטיביים. מידע נוסף זמין בכתובת https://www.json.org.
YAML (ראשי תיבות של YAML Ain't Markup Language) הוא תקן לסריאליזציה או לייצוג של נתונים, שמספק תחביר שאפשר למפות למבני נתונים, כמו רשימות, מערכי נתונים אסוסיאיטיביים ומשתני סקלאר. מידע נוסף זמין בכתובת https://yaml.org.
גם JSON וגם YAML הם פורמטים שקריאים למחשבים, אבל גם קל לאנשים לקרוא ולהבין אותם. באיור הבא מוצגת השוואה בין שני קטעים קצרים מאותה מפרטת OpenAPI שנכתבה באמצעות JSON ו-YAML:
אימות מפרט
עורך המפרט מאמת את מפרט OpenAPI בהתאם לתקן של מפרט OpenAPI. בזמן ההקלדה, אם יש שגיאות במפרט OpenAPI, תיפתח תיבת הדו-שיח Error (שגיאה) בחלק העליון של החלונית השמאלית בעורך המפרט. בתיבת הדו-שיח יוצגו פרטים נוספים על השגיאות ומספרי השורות המשויכים אליהן, כדי שתוכלו לתקן אותן בקלות.
שמירת מפרט
כדי לשמור מפרט OpenAPI, לוחצים על שמירה בסרגל הניווט העליון.
אם זו הפעם הראשונה ששומרים את המפרט, תתבקשו להזין שם קובץ. אם לא מציינים שם קובץ, ברירת המחדל היא Untitled. תוכלו לשנות את השם שלו מאוחר יותר.
סגירת מפרט
כדי לסגור מפרט OpenAPI בלי לשמור את השינויים, לוחצים על ביטול בסרגל הניווט העליון. המערכת תחזיר אתכם לרשימת המפרטים.