开发人员门户概述

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

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

API 管理开发人员门户

可用性

重要

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

从旧门户迁移

重要

旧开发人员门户现在已弃用,并且将仅接收安全更新。 你可以像往常一样继续使用它,直到它在 2023 年 10 月停用,届时将从所有 API 管理服务中将其删除。

专用文档文章中介绍了到新开发人员门户的迁移。

自定义和样式

可通过内置的拖放可视化编辑器对开发人员门户进行自定义和样式设置。 有关更多详细信息,请参阅本教程

扩展性

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

如果需要用自定义逻辑(不支持开箱即用)来扩展它,可以修改其代码库。 门户的代码库在 GitHub 存储库中可用。 例如,你可以实现与第三方支持系统集成的新的小组件。 实现新功能时,可以选择以下选项之一:

  • 在 API 管理服务之外自行承载生成的门户。 当你自行承载门户时,你将成为门户的维护人员并负责其升级。 Azure 支持的协助仅限于自承载门户的基本设置
  • 为 API 管理团队打开拉取请求,以将新功能合并到托管门户的代码库。

有关扩展性的详细信息和说明,请参阅 GitHub 存储库和有关实现小组件的教程。 自定义托管门户的教程介绍了门户的管理面板,该面板在托管版本和自承载版本中很常见 。

后续步骤

详细了解新开发人员门户:

浏览其他资源: