您正在查看 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 上的“smartdocs”代理(位于“VALIDATE”组织中)提供,该代理充当所有 SmartDocs 请求到预期端点的代理。在您安装 SmartDocs 时,系统会创建“smartdocs”代理。
例如:
SmartDocs 代理的网址会作为可配置的属性显示在“配置”->“SmartDocs”->“SmartDocs 代理网址”中。如果您的 API 位于专用网络中,并且通过门户使用 SmartDocs 的实时 API 请求会失败,您可能需要修改此网址。
开发者门户如何与 Edge 通信
开发者门户会存储和检索从 Edge 显示的大部分信息,包括 Smartdocs、开发者、产品和开发者应用。您可以使用菜单命令“配置”->“Devportal”来配置 Edge 组织信息和 devadmin 凭据。
如需了解详情,请参阅 在门户和 Edge 之间通信。