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
פקודה זו צריכה להחזיר את הפקודה הבאה אם SmartSmart מותקן:
[ "smartdocs", "passthrough" ]
- בממשק המשתמש של Edge, יוצרים ומעדכנים KVM בשם "smartdocs_whitelist", כפי שמופיע באיור שבהמשך.
יש ליצור את ה-KVM בארגון ובסביבה שבה מתבצעת כרגע הטמעה של שרת ה-proxy של SmartDocs.
הערה: צריך לוודא שהתיבה מוצפנת לא מסומנת.
- צריך להוסיף מפתח בשם 'is_whitelist_defined', שבו הערך הוא 'YES'.
- מוסיפים מפתח שני בשם 'allowed_hosts', כאשר הערכים הם שמות מארחים או כתובות IP שמופרדים ברווחים, שנקראים SmartSmart. הערך של '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".