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

您正在查看的是 Apigee Edge 文档。
转到 Apigee X 文档
信息

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

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

SmartDocs 的运作方式

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

例如:

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


开发者门户如何与边缘通信

开发者门户存储和检索其从 Edge 显示的大部分信息,包括 Smartdocs、开发者、产品和开发者应用。您可以使用菜单命令“配置”->“Devportal”来配置边缘组织信息和开发管理员凭据。

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