开发人员门户概述

  • 项目

开发人员门户是一个自动生成的、完全可自定义的网站，其中包含 API 的文档。 API 使用者可在其中找到 API、了解 API 的用法、请求访问权限以及试用这些 API。

如本文中所述，可以针对具体情况自定义和扩展开发人员门户。

API Management developer portal

可用性

重要

此功能在 API 管理的“高级”、“标准”、“基本”和“开发人员”层中可用 。

自定义托管门户并设置其样式

API 管理服务包括始终保持最新的内置托管开发人员门户。 可以从 Azure 门户界面访问它。

通过内置的拖放视觉对象编辑器对托管门户进行自定义和样式设置：

  • 使用视觉对象编辑器修改页面、媒体、布局、菜单、样式或网站设置。

  • 利用内置的小组件来添加文本、图像、按钮和其他对象，以便门户可以支持开箱即用。

  • 控制门户内容针对 API 管理实例中配置的不同用户和组的显示方式。 例如，仅向与特定产品关联的组或可以访问特定 API 的用户显示某些页面。

注意

托管开发人员门户会自动接收并应用更新。 更新期间，已保存但未发布到开发人员门户的更改将保持该状态。

扩展门户功能的选项

在某些情况下，你可能需要托管开发人员门户中提供的自定义和样式设置选项以外的功能。 如果需要实现不支持开箱即用的自定义逻辑，有几种选择：

  • 通过专为小型自定义设计的开发人员门户小组件直接添加自定义 HTML - 例如，为窗体添加 HTML 或嵌入视频播放器。 自定义代码以内联框架 (IFrame) 呈现。
  • 创建自定义小组件并将其上传以开发和添加更复杂的自定义门户功能。
  • 仅当需要对开发人员门户代码库的核心进行修改时，才自托管门户。 此选项需要高级配置。 Azure 支持的协助仅限于自承载门户的基本设置。

备注

由于 API 管理开发人员门户代码库在 GitHub 上维护，因此你可以随时提出问题并向 API 管理团队提出拉取请求以合并新功能。

后续步骤

详细了解开发人员门户：

浏览其他资源：