ApiProperties interface

套件:

@azure/arm-apicenter

API 屬性。

屬性

contacts	聯繫人集
customProperties	針對 API 目錄實體定義的自訂元數據。
description	API 的描述。
externalDocumentation	一組外部檔
kind	API 的種類。 例如，REST 或 GraphQL。
license	API 的授權資訊。
lifecycleStage	API 的目前生命周期階段。 注意：這個屬性不會串行化。 它只能由伺服器填入。
summary	API 的簡短描述。
termsOfService	API 的服務條款。
title	API 標題。

屬性詳細資料

contacts

聯繫人集

contacts?: Contact[]

屬性值

Contact[]

customProperties

針對 API 目錄實體定義的自訂元數據。

customProperties?: Record<string, unknown>

屬性值

Record<string, unknown>

description

API 的描述。

description?: string

屬性值

string

externalDocumentation

一組外部檔

externalDocumentation?: ExternalDocumentation[]

屬性值

ExternalDocumentation[]

kind

API 的種類。 例如，REST 或 GraphQL。

kind: string

屬性值

string

license

API 的授權資訊。

license?: License

屬性值

License

lifecycleStage

API 的目前生命周期階段。 注意：這個屬性不會串行化。 它只能由伺服器填入。

lifecycleStage?: string

屬性值

string

summary

API 的簡短描述。

summary?: string

屬性值

string

termsOfService

API 的服務條款。

termsOfService?: TermsOfService

屬性值

TermsOfService

title

API 標題。

title: string

屬性值

string