安装 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。
要完成安装,请执行以下操作:
确认 smartdocs.zip
文件位于以下目录中,以测试 SmartDocs 是否已安装:
/opt/apigee/apigee-validate/bundles/
或者在管理服务器节点上运行以下 API 调用:
curl -v -u adminEmail:adminPword 0:8080/v1/o/validate/apis
如果安装了 SmartDocs,此命令应返回以下内容:
[ "smartdocs", "passthrough" ]
- 在 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”中值。
如未另行说明,那么本页面中的内容已根据知识共享署名 4.0 许可获得了许可,并且代码示例已根据 Apache 2.0 许可获得了许可。有关详情,请参阅 Google 开发者网站政策。Java 是 Oracle 和/或其关联公司的注册商标。
最后更新时间 (UTC):2024-09-19。
[{
"type": "thumb-down",
"id": "missingTheInformationINeed",
"label":"没有我需要的信息"
},{
"type": "thumb-down",
"id": "tooComplicatedTooManySteps",
"label":"太复杂/步骤太多"
},{
"type": "thumb-down",
"id": "outOfDate",
"label":"内容需要更新"
},{
"type": "thumb-down",
"id": "translationIssue",
"label":"翻译问题"
},{
"type": "thumb-down",
"id": "samplesCodeIssue",
"label":"示例/代码问题"
},{
"type": "thumb-down",
"id": "otherDown",
"label":"其他"
}]
[{
"type": "thumb-up",
"id": "easyToUnderstand",
"label":"易于理解"
},{
"type": "thumb-up",
"id": "solvedMyProblem",
"label":"解决了我的问题"
},{
"type": "thumb-up",
"id": "otherUp",
"label":"其他"
}]
{"lastModified": "\u6700\u540e\u66f4\u65b0\u65f6\u95f4 (UTC)\uff1a2024-09-19\u3002"}
[[["易于理解","easyToUnderstand","thumb-up"],["解决了我的问题","solvedMyProblem","thumb-up"],["其他","otherUp","thumb-up"]],[["没有我需要的信息","missingTheInformationINeed","thumb-down"],["太复杂/步骤太多","tooComplicatedTooManySteps","thumb-down"],["内容需要更新","outOfDate","thumb-down"],["翻译问题","translationIssue","thumb-down"],["示例/代码问题","samplesCodeIssue","thumb-down"],["其他","otherDown","thumb-down"]],["最后更新时间 (UTC):2024-09-19。"],[],[]]