基于 Drupal 的开发者门户问题排查概览

您正在查看 Apigee Edge 文档。
前往 Apigee X 文档
信息

作为 API 提供方,您需要一种方式来公开您的 API、向开发者介绍您的 API、让开发者注册并让开发者注册应用。Apigee Edge 为您提供了一个 Developer Services 门户,您可以使用该门户构建和启动自己的自定义网站,以便向开发社区提供这些服务。如需详细了解开发者门户,请参阅什么是开发者门户?

以下各部分介绍了在排查开发者门户问题之前应了解的关键概念。

SmartDocs 的工作原理

您可以将描述 API 的 OpenAPI(JSON 或 YAML)或 WADL 规范导入 SmartDocs,并使用它将 API 参考文档发布到您的门户。API 参考文档会自动显示在您门户的“API”标签页下。开发者可以通过门户发现 API 文档,并发出实时 API 请求。由于 API 请求源自浏览器,因此需要 CORS(跨源资源共享)支持才能成功完成这些请求。CORS 支持由 Edge 上(在“VALIDATE”组织中)的“smartdocs”代理提供,该代理充当所有 SmartDocs 请求到目标端点的代理。当您安装 SmartDocs 时,系统会创建“smartdocs”代理。

例如:

SmartDocs 代理的网址作为可配置的属性公开,位于“配置”->“SmartDocs”->“SmartDocs 代理网址”。如果您的 API 位于专用网络上,并且使用 SmartDocs 从门户发送的实时 API 请求失败,您可能需要修改此网址。


开发者门户如何与 Edge 通信

开发者门户会存储并检索其显示的大部分信息(包括 Smartdocs、开发者、产品和开发者应用),这些信息都来自 Edge。您可以使用菜单命令“Configuration”>“Devportal”配置边缘组织信息和 devadmin 凭据。

如需了解详情,请参阅 在门户和 Edge 之间通信