התקנת SmartDocs

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 כחלק מהרצת הבדיקות.

כדי להשלים את ההתקנה:

  1. בודקים אם SmartDocs מותקן על ידי אישור שהקובץ smartdocs.zip שנמצא בספרייה הבאה:

    /opt/apigee/apigee-validate/bundles/

    לחלופין, מריצים את הקריאה הבאה ל-API בצומת של שרת הניהול:

    curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis

    אם מותקנת אצלך גרסת SmartDocs, הפקודה אמורה להחזיר את הנתונים הבאים:

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