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

此命令会在运行测试过程中安装 SmartDocs。

要完成安装，请执行以下操作：

1. 确认 smartdocs.zip 文件位于以下目录中，以测试是否安装了 SmartDocs：

   /opt/apigee/apigee-validate/bundles/

   或者，在 Management Server 节点上运行以下 API 调用：

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

   如果安装了 SmartDocs，此命令应返回以下内容：

   [ "smartdocs", "passthrough" ]

2. 在 Edge 界面中，创建和更新名为“smartdocs_whitelist”的 KVM，如下图所示。KVM 应在当前部署 SmartDocs 代理的组织和环境中创建。

   注意：请务必不要选中已加密对应的复选框。

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