다음을 통해 공유


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