인터페이스 메타데이터
인터페이스(Interface)는 공통 계약과 함께 식별, 표시와 검색에 필요한 메타데이터를 가집니다. 표시 이름과 코드에서 사용하는 API 이름을 구분합니다.
| 필드 | 의미와 예 |
|---|---|
| RID | 플랫폼이 자동 생성하는 고유 리소스 식별자(Resource identifier)입니다. 오류 메시지에서 해당 인터페이스를 가리킬 때 사용합니다. |
| Icon | 앱에 표시하는 그림과 색상입니다. 인터페이스 아이콘에는 객체 유형(Object type)과 구분하는 점선 테두리가 있습니다. Facility에는 건물 모양을 사용할 수 있습니다. |
| Display name | 사용자 앱에서 인터페이스에 접근하는 사람이 보는 이름입니다. 예제 값은 Facility입니다. |
| Description | 인터페이스를 설명하는 텍스트입니다. Facility의 예는 An abstract object type interface for representing airline facilities입니다. |
| API name | 코드에서 인터페이스를 참조할 이름입니다. Facility의 예제 API 이름은 facility입니다. |
| Status | 정의의 개발 상태를 사용자와 구축자에게 알리는 값입니다. active, experimental, example 또는 deprecated를 사용하며 기본값은 experimental입니다. |
| Searchable | 인터페이스의 객체들을 한 번에 로드하거나 검색할 수 있는지 정하는 Boolean 값입니다. 기본적으로 켜져 있습니다. |
검색 가능 여부와 구현 수
Searchable을 켠 인터페이스는 최대 75개 객체 유형이 구현할 수 있습니다. 검색 불가능한 인터페이스는 최대 1,000개 구현 유형을 지원합니다. 이 숫자는 객체 인스턴스의 개수가 아니라 인터페이스를 구현하는 객체 유형 수의 한도입니다.
여러 유형을 공통 검색에 포함할 계획이라면 구현과 앱별 지원을 확인하면서 Searchable을 선택합니다. API 이름이나 필수 계약을 바꿀 때에는 정의 수정의 호환성 조건을 따릅니다.