通过

Azure API 管理模板数据模型参考

本主题介绍 Azure API 管理中开发人员门户模板的数据模型中使用的常见项的实体和类型表示形式。

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

注释

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

可用性

重要

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

有关 v2 层（预览版）中的功能可用性，请参阅 v2 层概述。

参考文献

API（应用程序编程接口）

实体 API 具有以下属性：

房产 类型 DESCRIPTION
id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的 API。 该值是一个有效的相对 URL，其格式为 apis/{id}，其中{id} 为 API 标识符。 此属性为只读。
name 字符串 API 的名称。 不得为空。 最大长度为 100 个字符。
description 字符串 API 的说明。 不得为空。 可能包括 HTML 格式标记。 最大长度为 1000 个字符。
serviceUrl 字符串 实现此 API 的后端服务的绝对 URL。
path 字符串 API 管理的服务实例中，相对 URL 唯一标识此 API 及其所有资源路径。 它追加到服务实例创建期间指定的 API 终结点基 URL，以形成此 API 的公共 URL。
protocols 数字数组 描述可以调用此 API 中的作的协议。 允许的值为 1 - http 和 2 - https/或两者。
authenticationSettings 授权服务器身份验证设置 此 API 中包含的身份验证设置的集合。
subscriptionKeyParameterNames 物体 可选属性，可用于指定包含订阅密钥的查询和/或标头参数的自定义名称。 当此属性存在时，它必须至少包含以下两个属性之一。

{ "subscriptionKeyParameterNames": { "query": “customQueryParameterName", "header": “customHeaderParameterName" } }

API 摘要

实体 API summary 具有以下属性：

房产 类型 DESCRIPTION
id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的 API。 该值是格式为apis/{id}、其中{id}为API标识符的有效相对URL。 此属性为只读。
name 字符串 API 的名称。 不得为空。 最大长度为 100 个字符。
description 字符串 API 的说明。 不得为空。 可能包括 HTML 格式标记。 最大长度为 1000 个字符。

应用程序

实体 application 具有以下属性：

房产 类型 DESCRIPTION
Id 字符串 应用程序的唯一标识符。
Title 字符串 应用程序的标题。
Description 字符串 应用程序的说明。
Url URI 应用程序的 URI。
Version 字符串 应用程序的版本信息。
Requirements 字符串 应用程序要求的说明。
State 数字 应用程序的当前状态。

- 0 - 已注册

- 1 - 已提交

- 2 - 已发布

- 3 - 被拒绝

- 4 - 未发布
RegistrationDate DateTime 注册应用程序的日期和时间。
CategoryId 数字 应用程序类别（财务、娱乐等）
DeveloperId 字符串 提交应用程序的开发人员的唯一标识符。
Attachments 附件实体的集合。 应用程序的任何附件，例如屏幕截图或图标。
Icon 附件 应用程序的图标。

附件

实体 attachment 具有以下属性：

房产 类型 DESCRIPTION
UniqueId 字符串 附件的唯一标识符。
Url 字符串 资源的 URL。
Type 字符串 附件的类型。
ContentType 字符串 附件的媒体类型。

代码示例

房产 类型 DESCRIPTION
title 字符串 操作的名称。
snippet 字符串 此属性已弃用，不应使用。
brush 字符串 显示代码示例时要使用的代码语法着色模板。 允许的值为plain、php、java、xmlobjc、 pythonruby和csharp。
template 字符串 此代码示例模板的名称。
body 字符串 代码片段代码示例部分的占位符。
method 字符串 操作的 HTTP 方法。
scheme 字符串 用于操作请求的协议。
path 字符串 操作的路径。
query 字符串 包含已定义参数的查询字符串示例。
host 字符串 包含此作的 API 的 API 管理服务网关的 URL。
headers 标头实体的集合。 此操作的标头。
parameters 参数实体的集合。 为此操作定义的参数。

注释

实体 API 具有以下属性：

房产 类型 DESCRIPTION
Id 数字 注释的 ID。
CommentText 字符串 注释的正文。 可能包括 HTML。
DeveloperCompany 字符串 开发人员的公司名称。
PostedOn DateTime 发布批注的日期和时间。

問题

实体 issue 具有以下属性。

房产 类型 DESCRIPTION
Id 字符串 问题的唯一标识符。
ApiID 字符串 报告此问题的 API 的 ID。
Title 字符串 问题的标题。
Description 字符串 问题的说明。
SubscriptionDeveloperName 字符串 报告问题的开发人员的名字。
IssueState 字符串 问题的当前状态。 可能的值是“建议”、“已打开”、“已关闭”。
ReportedOn DateTime 问题报告的日期和时间。
Comments 注释实体的集合。 关于此问题的评论。
Attachments 附件实体的集合。 问题的任何附件。
Services API 实体的集合。 提交问题的用户订阅的 API。

筛选

实体 filtering 具有以下属性：

房产 类型 DESCRIPTION
Pattern 字符串 当前搜索词;或者 null 如果没有搜索词。
Placeholder 字符串 未指定搜索词时，将在搜索框中显示的文本。

本部分描述 parameter 的表示形式。

房产 类型 DESCRIPTION
name 字符串 参数名称。
description 字符串 参数说明。
value 字符串 标头值。
typeName 字符串 标头值的数据类型。
options 字符串 选项。
required 布尔 是否需要标头。
readOnly 布尔 标头是否为只读。

HTTP 请求

本部分介绍表示 request 形式。

房产 类型 DESCRIPTION
description 字符串 作请求说明。
headers 标头实体的数组。 请求标头。
parameters 参数数组 作请求参数的集合。
representations 表示形式的数组 作请求表示形式的集合。

HTTP 响应

本部分介绍 response 表示。

房产 类型 DESCRIPTION
statusCode 正整数 作响应状态代码。
description 字符串 操作响应描述。
representations 表示形式的数组 操作响应表示的集合。

操作

实体 operation 具有以下属性：

房产 类型 DESCRIPTION
id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的作。 该值是一个有效的相对 URL，格式为 apis/{aid}/operations/{id}，其中 {aid} 是 API 标识符，{id} 是操作标识符。 此属性为只读。
name 字符串 操作的名称。 不得为空。 最大长度为 100 个字符。
description 字符串 操作的说明。 不得为空。 可能包括 HTML 格式标记。 最大长度为 1000 个字符。
scheme 字符串 描述在此 API 中可以调用哪些协议上的操作。 允许的值为http、https，或同时包含http和https。
uriTemplate 字符串 标识此作的目标资源的相对 URL 模板。 可能包括参数。 示例：customers/{cid}/orders/{oid}/?date={date}
host 字符串 托管 API 的 API 管理网关 URL。
httpMethod 字符串 操作 HTTP 方法。
request HTTP 请求 包含请求详细信息的实体。
responses HTTP 响应数组 操作 HTTP 响应 实体的数组。

实体 operation menu 具有以下属性：

房产 类型 DESCRIPTION
ApiId 字符串 当前 API 的 ID。
CurrentOperationId 字符串 当前操作的ID。
Action 字符串 菜单类型。
MenuItems 操作菜单项实体的集合。 当前 API 的操作。

实体 operation menu item 具有以下属性：

房产 类型 DESCRIPTION
Id 字符串 作的 ID。
Title 字符串 操作的说明。
HttpMethod 字符串 操作的 Http 方法。

寻呼

实体 paging 具有以下属性：

房产 类型 DESCRIPTION
Page 数字 当前页码。
PageSize 数字 要显示在单个页面上的最大结果。
TotalItemCount 数字 要显示的项数。
ShowAll 布尔 是否在单个页面上推出所有结果。
PageCount 数字 结果页数。

参数

本部分介绍parameter的表示法。

房产 类型 DESCRIPTION
name 字符串 参数名称。
description 字符串 参数说明。
value 字符串 参数值。
options 字符串数组 为查询参数值定义的值。
required 布尔 指定参数是否是必需的。
kind 数字 此参数是路径参数 （1），还是查询字符串参数 （2）。
typeName 字符串 Parameter type.

产品

实体 product 具有以下属性：

房产 类型 DESCRIPTION
Id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的产品。 该值是一个有效的相对 URL，格式为products/{pid}，其中{pid}是产品标识符。 此属性为只读。
Title 字符串 产品的名称。 不得为空。 最大长度为 100 个字符。
Description 字符串 产品的描述。 不得为空。 可能包括 HTML 格式标记。 最大长度为 1000 个字符。
Terms 字符串 产品使用条款。 尝试订阅产品的开发人员将被要求接受并确认这些条款，才能完成订阅过程。
ProductState 数字 指定产品是否发布。 开发人员门户上的开发人员可发现已发布的产品。 非已发布的产品仅对管理员可见。

产品状态的允许值为：

- 0 - Not Published

- 1 - Published

- 2 - Deleted
AllowMultipleSubscriptions 布尔 指定用户是否可以同时拥有此产品的多个订阅。
MultipleSubscriptionsCount 数字 允许用户同时拥有此产品的最大订阅数。

提供者

实体 provider 具有以下属性：

房产 类型 DESCRIPTION
Properties 字符串字典 此身份验证提供程序的属性。
AuthenticationType 字符串 提供程序类型。 （Microsoft Entra ID、Facebook 登录名、Google 帐户、Microsoft帐户、Twitter）。
Caption 字符串 提供程序的显示名称。

表示形式

本部分介绍一个 representation。

房产 类型 DESCRIPTION
contentType 字符串 指定此表示形式的已注册或自定义内容类型，例如 application/xml。
sample 字符串 表示形式的示例。

订阅

实体 subscription 具有以下属性：

房产 类型 DESCRIPTION
Id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的订阅。 该值是一个有效的相对 URL，格式为 subscriptions/{sid}，其中 {sid} 是订阅标识符。 此属性为只读。
ProductId 字符串 已订阅产品的产品资源标识符。 该值是一个有效的相对 URL，products/{pid}格式为产品标识符。{pid}
ProductTitle 字符串 产品的名称。 不得为空。 最大长度为 100 个字符。
ProductDescription 字符串 产品的描述。 不得为空。 可能包括 HTML 格式标记。 最大长度为 1000 个字符。
ProductDetailsUrl 字符串 产品详细信息的相对 URL。
state 字符串 订阅的状态。 可能的状态包括：

- 0 - suspended – 订阅被阻止，订阅者无法调用产品的任何 API。

- 1 - active – 订阅处于活动状态。

- 2 - expired – 订阅已过期并已停用。

- 3 - submitted – 开发人员已发出订阅请求，但尚未获得批准或拒绝。

- 4 - rejected – 管理员拒绝了订阅请求。

- 5 - cancelled – 开发人员或管理员已取消订阅。
DisplayName 字符串 订阅的显示名称。
CreatedDate dateTime 订阅的创建日期，格式为 ISO 8601： 2014-06-24T16:25:00Z。
CanBeCancelled 布尔 当前用户是否可以取消订阅。
IsAwaitingApproval 布尔 订阅是否正在等待审批。
StartDate 日期时间 订阅的开始日期，格式为 ISO 8601： 2014-06-24T16:25:00Z。
ExpirationDate 日期时间 订阅的到期日期，格式为 ISO 8601： 2014-06-24T16:25:00Z。
NotificationDate dateTime 订阅的通知日期，格式为 ISO 8601： 2014-06-24T16:25:00Z。
primaryKey 字符串 主订阅密钥。 最大长度为 256 个字符。
secondaryKey 字符串 辅助订阅密钥。 最大长度为 256 个字符。
CanBeRenewed 布尔 当前用户是否可以续订订阅。
HasExpired 布尔 订阅是否已过期。
IsRejected 布尔 订阅请求是否被拒绝。
CancelUrl 字符串 取消订阅的相对 URL。
RenewUrl 字符串 续订订阅的相对 URL。

订阅摘要

实体 subscription summary 具有以下属性：

房产 类型 DESCRIPTION
Id 字符串 资源标识符。 唯一标识当前 API 管理服务实例中的订阅。 该值是格式为 subscriptions/{sid} 的有效相对 URL，其中 {sid} 是订阅标识符。 此属性为只读。
DisplayName 字符串 订阅的显示名称

用户帐户信息

实体 user account info 具有以下属性：

房产 类型 DESCRIPTION
FirstName 字符串 名字。 不得为空。 最大长度为 100 个字符。
LastName 字符串 姓。 不得为空。 最大长度为 100 个字符。
Email 字符串 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 最大长度为 254 个字符。
Password 字符串 用户帐户密码。
NameIdentifier 字符串 帐户标识符，与用户电子邮件相同。
ProviderName 字符串 身份验证提供程序名称。
IsBasicAccount 布尔 为 true 如果此帐户是使用电子邮件和密码注册的；为 false 如果此帐户是使用提供程序注册的。

用户登录

实体 user sign in 具有以下属性：

房产 类型 DESCRIPTION
Email 字符串 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 最大长度为 254 个字符。
Password 字符串 用户帐户密码。
ReturnUrl 字符串 用户单击登录的页面的 URL。
RememberMe 布尔 是否保存当前用户的信息。
RegistrationEnabled 布尔 是否启用注册。
DelegationEnabled 布尔 是否启用委派登录。
DelegationUrl 字符串 委派的登录 URL（如果已启用）。
SsoSignUpUrl 字符串 用户的单一登录 URL（如果存在）。
AuxServiceUrl 字符串 如果当前用户是管理员，则这是指向 Azure 门户中服务实例的链接。
Providers 服务提供者实体的集合 此用户的身份验证提供程序。
UserRegistrationTerms 字符串 用户在登录之前必须同意的条款。
UserRegistrationTermsEnabled 布尔 是否启用术语。

用户注册

实体 user sign up 具有以下属性：

房产 类型 DESCRIPTION
PasswordConfirm 布尔 注册注册控件使用的值。
Password 字符串 用户帐户密码。
PasswordVerdictLevel 数字 注册注册控件使用的值。
UserRegistrationTerms 字符串 用户在登录之前必须同意的条款。
UserRegistrationTermsOptions 数字 注册注册控件使用的值。
ConsentAccepted 布尔 注册注册控件使用的值。
Email 字符串 电子邮件地址。 不能为空，并且必须在服务实例中是唯一的。 最大长度为 254 个字符。
FirstName 字符串 名字。 不得为空。 最大长度为 100 个字符。
LastName 字符串 姓。 不得为空。 最大长度为 100 个字符。
UserData 字符串 注册控件使用的值。
NameIdentifier 字符串 注册注册控件使用的值。
ProviderName 字符串 身份验证提供程序名称。

后续步骤

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