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

這個指令會在執行測試時安裝 SmartDoc。

如要完成安裝程序：

  1. 確認 smartdocs.zip 檔案為 位於以下目錄：

    /opt/apigee/apigee-validate/bundles/

    或在 Management Server 節點上執行下列 API 呼叫：

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

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

    [ "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」值。如果主機 ，SmartDoc 回應就會含有內容 400 Bad Request Bad Request-Hostname not permitted 的酬載。
    ，瞭解如何調查及移除這項存取權。 KVM 建立介面 注意：如果您不新增及設定這個 KVM，則 Proxy 不會強制執行許可清單。這個 可能會在未經授權的情況下存取主機和 IP 位址。只有主機名稱和 IP 位址 使用 SmartDoc 記錄的 API 端點應包含在「allowed_hosts」中輕鬆分配獎金