Azure API 管理页面控件

Azure API 管理提供以下控件,适用于开发人员门户模板。

要使用控件,请将其放在开发人员门户模板中的所需位置。 某些控件(例如 app-actions 控件)有参数,如以下示例所示:

<app-actions params="{ appId: '{{app.id}}' }"></app-actions>  

参数的值作为模板的数据模型的一部分传入。 大多数情况下,只需粘贴提供的每个控件的示例,即可正常使用该控件。 有关参数值的详细信息,可参阅每个模板的数据模型部分,其中可能使用了控件。

如需详细了解如何使用模板,请参阅如何使用模板自定义 API 管理开发人员门户

注意

以下文档内容与已弃用的开发人员门户有关。 你可以像往常一样继续使用它,直到它在 2023 年 10 月停用,届时将从所有 API 管理服务中将其删除。 弃用的门户只会接收关键安全更新。 有关更多详细信息,请参阅以下文章:

可用性

重要

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

开发人员门户模板页面控件

app-actions

app-actions 控件提供的用户界面适用于与开发人员门户中用户配置文件页上的应用程序交互。

app-actions control

使用情况

<app-actions params="{ appId: '{{app.id}}' }"></app-actions>  

参数

参数 说明
appId 应用程序的 ID。

开发人员门户模板

app-actions 控件可用于以下开发人员门户模板:

basic-signin

basic-signin 控件提供了一个控件,用于收集开发人员门户中登录页上的用户登录信息。

basic-signin control

使用情况

<basic-SignIn></basic-SignIn>  

参数

无。

开发人员门户模板

basic-signin 控件可用于以下开发人员门户模板:

paging-control

paging-control 在开发人员门户页上提供分页功能,该页面会显示项目列表。

paging control

使用情况

<paging-control></paging-control>  

参数

无。

开发人员门户模板

paging-control 控件可用于以下开发人员门户模板:

providers

providers 控件提供了一个控件,用于在开发人员门户的登录页中选择身份验证提供程序。

providers control

使用情况

<providers></providers>  

参数

无。

开发人员门户模板

providers 控件可用于以下开发人员门户模板:

search-control

search-control 在开发人员门户页上提供搜索功能,该页面会显示项目列表。

search control

使用情况

<search-control></search-control>  

参数

无。

开发人员门户模板

search-control 控件可用于以下开发人员门户模板:

注册

sign-up 控件提供了一个控件,用于收集开发人员门户中注册页上的用户配置文件信息。

sign-up control

使用情况

<sign-up></sign-up>  

参数

无。

开发人员门户模板

sign-up 控件可用于以下开发人员门户模板:

subscribe-button

subscribe-button 提供了一个控件,可供用户订阅产品。

subscribe-button control

使用情况

<subscribe-button></subscribe-button>  

参数

无。

开发人员门户模板

subscribe-button 控件可用于以下开发人员门户模板:

subscription-cancel

subscription-cancel 控件提供了一个控件,用于在开发人员门户的用户配置文件页中取消产品订阅。

subscription-cancel control

使用情况

<subscription-cancel params="{ subscriptionId: '{{subscription.id}}', cancelUrl: '{{subscription.cancelUrl}}' }">  
</subscription-cancel>  
  

参数

参数 说明
subscriptionId 要取消的订阅的 ID。
cancelUrl 订阅取消 URL。

开发人员门户模板

subscription-cancel 控件可用于以下开发人员门户模板:

后续步骤

如需详细了解如何使用模板,请参阅如何使用模板自定义 API 管理开发人员门户