כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של
Apigee X. מידע
יצירה ואימות של מפרטי OpenAPI בלי לכתוב קוד באמצעות עורך המפרטים.
כניסה לעורך המפרטים
פותחים מפרט OpenAPI בעורך המפרטים, כמתואר בקטעים הבאים:
באיור הבא מוצג המפרט ל-Petstore API הפתוח בעורך המפרטים:
כפי שמודגש באיור הקודם, עורך המפרטים מאפשר:
- יוצרים את מפרט ה-OpenAPI כדי לבנות מודל של ה-API בפורמט JSON או YAML בחלונית הימנית.
- תוכלו לצפות בתיעוד ה-API שנוצר באופן אוטומטי בחלונית השמאלית.
- אימות המפרט שלכם לפי תקן OpenAPI Specification, תוך כדי הקלדה.
- שומרים את מפרט 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, עורך המפרט מציג את תיבת הדו-שיח 'שגיאה' בחלק העליון של החלונית השמאלית ומספק מידע נוסף על השגיאות ועל מספרי השורות המשויכים אליהן כדי שתוכלו לתקן אותן בקלות.
שמירת מפרט
כדי לשמור מפרט OpenAPI, לוחצים על Save (שמירה) בסרגל הניווט העליון.
אם זו הפעם הראשונה שאתם שומרים את המפרטים, תתבקשו להזין שם קובץ. אם לא תציינו שם קובץ, ברירת המחדל תהיה 'ללא שם'. תוכלו לשנות את השם שלה מאוחר יותר.
סגירת מפרט
כדי לסגור מפרט OpenAPI בלי לשמור את העריכות, לוחצים על ביטול בסרגל הניווט העליון. תוחזר לרשימת המפרטים.