SmartDocs מותקן באופן אוטומטי כשמתקינים ומריצים את סקריפטים לבדיקת ההתקנה שמפורטים בקטע בדיקת ההתקנה. כחלק מהפעלת הבדיקה מריצים את הפקודות הבאות:
/opt/apigee/apigee-service/bin/apigee-service apigee-validate install
/opt/apigee/apigee-service/bin/apigee-service apigee-validate setup -f configFile
configFile הוא אותו קובץ תצורה שבו השתמשתם כדי להתקין את Edge. למידע נוסף, ראו התקנת רכיבי Edge בצומת.
הפקודה הזו מתקינה את SmartDocs כחלק מהרצת הבדיקות.
כדי להשלים את ההתקנה:
בודקים אם SmartDocs מותקן על ידי אישור שהקובץ
smartdocs.zipשנמצא בספרייה הבאה:/opt/apigee/apigee-validate/bundles/
לחלופין, אפשר להריץ את קריאת ה-API הבאה בצומת של שרת הניהול:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
אם מותקנת אצלך גרסת SmartDocs, הפקודה אמורה להחזיר את הנתונים הבאים:
[ "smartdocs", "passthrough" ]
- בממשק המשתמש של Edge, יוצרים ומעדכנים KVM בשם smartdocs_whitelist, כפי שמוצג באיור שבהמשך.
יש ליצור את ה-KVM בארגון ובסביבה שבהם שרת ה-proxy SmartDocs
שנפרסה כרגע.
הערה: חשוב לוודא שהתיבה הצפנה לא מסומנת.
- מוסיפים מפתח בשם 'is_whitelist_defined', כאשר הערך הוא 'כן'.
- מוסיפים מפתח שני בשם 'allowed_hosts', שבו הערכים הם כתובות IP או שמות מארחים מופרדים ברווחים.
שנקראה מ-SmartDocs. הערך של 'allowed_hosts' צריך לכלול את כל המארחים שכלולים במפרטי OpenAPI
נוסף ל-SmartDocs. לדוגמה, אם יש לכם מפרט OpenAPI שקורא ל-
mocktarget.apigee.net, יהיה עליך להוסיף אתmocktarget.apigee.netל- "allowed_hosts" עם ערך מסוים. אם מארח לא נכלל ב-KVM, התגובה של SmartDocs תהיה400 Bad Requestעם תוכן של עומס שימושי (payload) שלBad Request-Hostname not permitted.
הערה: אם לא מוסיפים ומגדירים את ה-KVM הזה, שרת ה-proxy לא יאכוף הוספה לרשימת ההיתרים. כתוצאה מכך, יכולה להיות גישה לא מורשית למארחים ולכתובות ה-IP שלכם. רק שמות מארחים וכתובות IP של
נקודות הקצה ל-API שמתועדות ב-SmartDocs צריכות להיכלל ב-"allowed_hosts". ערכים.