安装 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/

    或者,在管理服务器节点上运行以下 API 调用:

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

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

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

    注意:请确保未勾选加密复选框。

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