安裝 SmartDoc

當您安裝並執行「測試安裝」一節所述的安裝測試指令碼時,系統會自動安裝 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.zip 檔案位於下列目錄,測試是否已安裝 SmartDocs:

    /opt/apigee/apigee-validate/bundles/

    或在管理伺服器節點上執行下列 API 呼叫:

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

    如果已安裝 SmartDocs,這個指令應會傳回下列內容:

    [ "smartdocs", "passthrough" ]
  2. 在 Edge UI 中,建立及更新 KVM,並命名為「smartdocs_whitelist」,如下圖所示。 KVM 應建立在目前部署 SmartDocs Proxy 的組織和環境中。

    注意:請確認「加密」方塊未勾選。

    • 新增名為「is_whitelist_configured」的鍵,並將值設為「YES」。
    • 新增第二個名為「allowed_hosts」的鍵,其值為從 SmartDocs 呼叫的主機名稱或 IP 位址,並以空格分隔。「allowed_hosts」的值應包含新增至 SmartDocs 的 OpenAPI 規格中的任何主機。舉例來說,如果 OpenAPI 規格會呼叫 mocktarget.apigee.net,您就必須將 mocktarget.apigee.net 新增至「allowed_hosts」值。如果 KVM 中不含主機,SmartDocs 回應會是 400 Bad Request,內容酬載為 Bad Request-Hostname not permitted。
    KVM 建立介面 注意:如未新增及設定這個 KVM,Proxy 就不會強制執行許可清單。這可能會導致未經授權的使用者存取您的主機和 IP 位址。「allowed_hosts」值只能包含 SmartDocs 記錄的 API 端點主機名稱和 IP 位址。