安装 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 的同一配置文件。 如需了解详情，请参阅在节点上安装边缘组件。

此命令会在运行测试时安装 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 界面中，创建并更新一个名为“smartdocs_whitelist”的 KVM，如下图所示。 KVM 应在 SmartDocs 代理所在的组织和环境中创建 当前已部署的资源

   注意：请确保已加密复选框未选中。

   • 添加一个名为“is_whitelist_configured”的键，其值为“YES”。
   • 再添加一个名为“allowed_hosts”的键，其中的值是以空格分隔的主机名或 IP 地址 从 SmartDocs 中调用。“allowed_hosts”的值应包含 OpenAPI 规范中包含的任何主机 添加到 SmartDocs 中。例如，如果您的 OpenAPI 规范调用 mocktarget.apigee.net，您需要将 mocktarget.apigee.net 添加到“allowed_hosts”值。如果 KVM 中不包含主机，SmartDocs 响应将为 400 Bad Request，内容载荷为 Bad Request-Hostname not permitted。
   注意：如果您不添加和配置此 KVM，则代理不会强制执行白名单。这可能会导致对您的主机和 IP 地址进行未经授权的访问。仅限 SmartDocs 记录的 API 端点应包含在“allowed_hosts”中值。