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