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