安裝 SmartDoc

當你安裝及執行安裝測試指令碼時，系統會自動安裝 SmartDoc 請參閱「測試安裝」一文。執行測試指令碼時，您會執行下列指令：

/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 檔案為 位於以下目錄：

   /opt/apigee/apigee-validate/bundles/

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

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

   如果已安裝 SmartDocs，這項指令應傳回以下內容：

   [ "smartdocs", "passthrough" ]

2. 在 Edge UI 中，建立並更新名為「smartdocs_whitelist」的 KVM，如下圖所示。 KVM 應在 SmartDocs Proxy 所在的機構與環境中建立 目前部署的資源數量

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

   • 新增名為「is_whitelist_setting」的鍵，其值為「YES」。
   • 新增另一個名為「allowed_hosts」的鍵，其中的值是以空格分隔主機名稱或 IP 位址 稱為 SmartDoc 呼叫。「allowed_hosts」的值應包含 OpenAPI 規格中所有的主機 已加入 SmartDoc。舉例來說，如果您的 OpenAPI 規格呼叫 mocktarget.apigee.net， 您必須將 mocktarget.apigee.net 新增至「allowed_hosts」值。如果 KVM 中未納入主機，SmartDocs 回應會是 400 Bad Request，內容酬載為 Bad Request-Hostname not permitted。
   注意：如果您未新增及設定這個 KVM，Proxy 就不會強制執行白名單。這個 可能會在未經授權的情況下存取主機和 IP 位址。只有使用 SmartDocs 記錄的 API 端點主機名稱和 IP 位址，才能納入「allowed_hosts」值。