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 בארגון ובסביבה שבהם פרוקסי SmartDocs פרוס כרגע.
הערה: חשוב לוודא שהתיבה מוצפן לא מסומנת.
- מוסיפים מפתח בשם is_whitelist_configured, כשהערך הוא YES.
- מוסיפים מפתח שני בשם "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.