ApiProperties interface
API 属性。
属性
| contacts | 联系人集 |
| custom |
为 API 目录实体定义的自定义元数据。 |
| description | API 的说明。 |
| external |
外部文档集 |
| kind | API 类型。 例如,REST 或 GraphQL。 |
| license | API 的许可证信息。 |
| lifecycle |
API 的当前生命周期阶段。 注意:此属性不会序列化。 它只能由服务器填充。 |
| summary | API 的简短说明。 |
| terms |
API 的服务条款。 |
| title | API 标题。 |
属性详细信息
contacts
customProperties
为 API 目录实体定义的自定义元数据。
customProperties?: Record<string, unknown>
属性值
Record<string, unknown>
description
API 的说明。
description?: string
属性值
string
externalDocumentation
kind
API 类型。 例如,REST 或 GraphQL。
kind: string
属性值
string
license
lifecycleStage
API 的当前生命周期阶段。 注意:此属性不会序列化。 它只能由服务器填充。
lifecycleStage?: string
属性值
string
summary
API 的简短说明。
summary?: string
属性值
string
termsOfService
title
API 标题。
title: string
属性值
string