ApiEntityBaseContract interface
API 기본 계약 세부 정보입니다.
속성
| api |
API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다. |
| api |
API 수정 버전에 대한 설명입니다. |
| api |
API의 유형입니다. |
| api |
API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다. |
| api |
API 버전에 대한 설명입니다. |
| api |
관련 ApiVersionSet에 대한 리소스 식별자입니다. |
| authentication |
이 API에 포함된 인증 설정의 컬렉션입니다. |
| contact | API에 대한 연락처 정보입니다. |
| description | API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다. |
| is |
API 수정 버전이 현재 API 수정 버전인지를 나타냅니다. |
| is |
게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다. |
| license | API에 대한 라이선스 정보입니다. |
| subscription |
API를 사용할 수 있는 프로토콜입니다. |
| subscription |
API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다. |
| terms |
API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다. |
속성 세부 정보
apiRevision
API의 수정 버전에 대해 설명합니다. 값이 제공되지 않으면 기본 수정 버전 1이 생성됩니다.
apiRevision?: string
속성 값
string
apiRevisionDescription
API 수정 버전에 대한 설명입니다.
apiRevisionDescription?: string
속성 값
string
apiType
API의 유형입니다.
apiType?: string
속성 값
string
apiVersion
API 버전이 지정된 경우 API의 버전 식별자를 나타냅니다.
apiVersion?: string
속성 값
string
apiVersionDescription
API 버전에 대한 설명입니다.
apiVersionDescription?: string
속성 값
string
apiVersionSetId
관련 ApiVersionSet에 대한 리소스 식별자입니다.
apiVersionSetId?: string
속성 값
string
authenticationSettings
이 API에 포함된 인증 설정의 컬렉션입니다.
authenticationSettings?: AuthenticationSettingsContract
속성 값
contact
description
API에 대한 설명입니다. HTML 서식 태그를 포함할 수 있습니다.
description?: string
속성 값
string
isCurrent
API 수정 버전이 현재 API 수정 버전인지를 나타냅니다.
isCurrent?: boolean
속성 값
boolean
isOnline
게이트웨이를 통해 API 수정 버전에 액세스할 수 있는지를 나타냅니다. 참고: 이 속성은 serialize되지 않습니다. 서버에서만 채울 수 있습니다.
isOnline?: boolean
속성 값
boolean
license
subscriptionKeyParameterNames
API를 사용할 수 있는 프로토콜입니다.
subscriptionKeyParameterNames?: SubscriptionKeyParameterNamesContract
속성 값
subscriptionRequired
API에 액세스하는 데 API 또는 제품 구독이 필요한지 여부를 지정합니다.
subscriptionRequired?: boolean
속성 값
boolean
termsOfServiceUrl
API에 대한 서비스 약관에 대한 URL입니다. URL 형식이어야 합니다.
termsOfServiceUrl?: string
속성 값
string