安裝 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 元件」。

這個指令會在測試期間安裝 SmartDoc。

完成安裝程序的步驟如下：

1. 確認 smartdocs.zip 檔案位於下列目錄中，以測試 SmartDoc 是否已安裝完成：

   /opt/apigee/apigee-validate/bundles/

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

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

   如果已安裝 SmartDoc，這個指令應該會傳回下列內容：

   [ "smartdocs", "passthrough" ]

2. 在 Edge UI 中，建立並更新名為「smartdocs_whitelist」的 KVM，如下圖所示。您應該在目前部署 SmartDoc Proxy 的機構和環境中建立 KVM。

   注意：請勿勾選 [已加密] 方塊。

   • 新增名為「is_whitelist_configure」的鍵，其中的值為「YES」。
   • 新增名為「allowed_hosts」的第二個鍵，其值是以空格分隔的主機名稱或 IP 呼叫的 IP 位址。「allowed_hosts」的值應包含在 SmartDoc 中加入的 OpenAPI 規格中包含的任何主機。舉例來說，如果有 OpenAPI 規格會呼叫 mocktarget.apigee.net，您就必須將 mocktarget.apigee.net 新增至「allowed_hosts」值。如果 KVM 中未包含主機，則 SmartDoc 回應為 400 Bad Request，其中內容酬載為 Bad Request-Hostname not permitted。
   注意：如果您未新增及設定這個 KVM，Proxy 不會強制執行許可清單。以免他人未經授權存取您的主機和 IP 位址。只有透過 SmartDoc 記錄的 API 端點的主機名稱和 IP 位址都必須包含在「allowed_hosts」值中。