你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

ApiProperties interface

API 属性。

属性

contacts

联系人集

customProperties

为 API 目录实体定义的自定义元数据。

description

API 的说明。

externalDocumentation

外部文档集

kind

API 类型。 例如,REST 或 GraphQL。

license

API 的许可证信息。

lifecycleStage

API 的当前生命周期阶段。 注意:此属性不会序列化。 它只能由服务器填充。

summary

API 的简短说明。

termsOfService

API 的服务条款。

title

API 标题。

属性详细信息

contacts

联系人集

contacts?: Contact[]

属性值

customProperties

为 API 目录实体定义的自定义元数据。

customProperties?: Record<string, unknown>

属性值

Record<string, unknown>

description

API 的说明。

description?: string

属性值

string

externalDocumentation

外部文档集

externalDocumentation?: ExternalDocumentation[]

属性值

kind

API 类型。 例如,REST 或 GraphQL。

kind: string

属性值

string

license

API 的许可证信息。

license?: License

属性值

lifecycleStage

API 的当前生命周期阶段。 注意:此属性不会序列化。 它只能由服务器填充。

lifecycleStage?: string

属性值

string

summary

API 的简短说明。

summary?: string

属性值

string

termsOfService

API 的服务条款。

termsOfService?: TermsOfService

属性值

title

API 标题。

title: string

属性值

string