Azure API Management新开发者门户能否创建特定API专属页面？

一、如何创建特定API专属的页面/信息板块 #

其实新开发者门户完全支持为单个API定制专属内容，你可以通过以下几种方式实现：

1. 利用API详情页的自定义内容区块 #

每个API的详情页面（用户查看API具体操作的页面）允许添加自定义HTML/Markdown内容板块。操作步骤如下：

• 登录APIM实例的新开发者门户管理界面（通过Azure门户进入APIM，选择“开发者门户”>“编辑”）
• 找到目标API的详情页，进入编辑模式
• 添加一个“自定义内容”组件，把Webhook事件数据的说明、示例（比如事件payload结构、触发条件、如何在API操作中使用这些数据）用Markdown格式写进去
• 这个组件只会出现在你选定的API详情页上，其他API不会显示，完美实现专属内容的需求

2. 创建独立的专属页面并关联到API #

如果内容较多不想挤在API详情页里，你可以：

• 在门户管理界面创建一个新的自定义页面，专门用来介绍该API的Webhook事件数据
• 编辑目标API的详情页，添加一个“链接”组件指向这个新页面
• 或者在API的“概述”标签里，直接把页面链接嵌入到自定义内容中，方便用户快速访问

二、如果无法创建专属页面的替代方案 #

如果因为权限、版本限制等原因没法单独创建专属页面，你可以把这些信息放在以下几个合适的位置：

1. API操作的描述字段里 #

针对需要用到Webhook事件数据的具体API操作，在操作的“描述”中添加相关说明。比如：

此操作可使用创建新条目时Webhook推送的事件数据，事件payload示例：

{
  "eventType": "entryCreated",
  "entryId": "12345",
  "timestamp": "2024-05-20T10:00:00Z"
}

用户查看该操作时就能直接看到相关信息，关联性很强。

2. 门户“文档”板块下的API专属分类 #

如果门户有统一的文档区域，你可以创建一个以API名称命名的分类，把Webhook事件数据的说明放在这个分类下。用户通过导航就能找到对应API的专属文档内容。

3. API的政策说明区域（若适用） #

如果Webhook事件数据是和API政策结合使用的，你可以在政策编辑器里添加注释，或者在门户展示政策的区域补充相关信息——这个方式更适合技术细节较强的内容。

总的来说，优先推荐利用API详情页的自定义内容区块或者独立关联页面，这两种方式最贴合用户习惯：用户查看目标API时就能直接找到对应的Webhook事件信息，不用额外跳转。

内容的提问来源于stack exchange，提问作者Riri