Utility API
Utility API는 독립형 기능 조각이자, 플러그인이 사용을 요청할 수 있는 인터페이스예요. 이들은 TypeScript 인터페이스와 구현에 접근하는 데 사용되는 참조("API ref")로 정의돼요. 플러그인과 핵심 프레임워크 모두가 제공할 수 있으며, 이들 자체가 입력을 가질 수 있고, 교체될 수 있고, app-config에서 선언적으로 구성될 수 있는 확장이에요.
출처: 문서
본문
개요 (Overview)
Utility API는 독립형 기능 조각이자, 플러그인이 사용을 요청할 수 있는 인터페이스예요. 이들은 TypeScript 인터페이스와 구현에 접근하는 데 사용되는 참조("API ref")로 정의돼요. 플러그인과 핵심 프레임워크 모두가 제공할 수 있으며, 이들 자체가 입력을 가질 수 있고, 교체될 수 있고, app-config에서 선언적으로 구성될 수 있는 확장이에요.
Utility API의 흔한 예시는 catalog client처럼 플러그인의 백엔드 부분과 상호작용하는 클라이언트 인터페이스예요. 그러면 어떤 프론트엔드 플러그인도 요청을 보내기 위해 그 인터페이스의 구현을 요청할 수 있어요.
다음 다이어그램은 두 플러그인에 의존하고 추가 재정의도 제공하는 가상의 애플리케이션을 보여줘요. 플러그인과 핵심 프레임워크 모두 Utility API를 제공하고 서로 의존한다는 점에 유의하세요. 앱은 또한 재정의 메커니즘을 사용해 기본 구현보다 우선하는 하나의 API 교체 구현을 제공하기로 선택해요. 따라서 그 API의 모든 소비자는 반드시 그 새 구현을 제공받게 돼요.
확장 구조 (Extension structure)
모든 Utility API는 createApiExtension.factoryDataRef 출력 데이터 유형을 구현하며, 누가 제공했든 상관없이 반드시 core 확장의 apis 입력에만 부착해야 해요. 이러한 기본값은 createApiExtension 프레임워크 함수가 기본으로 제공해요.
Utility API는 확장이므로 고급 사용 사례에서는 입력을 가질 수도 있어요. 이는 도입자가 추가 프로그래밍 기능으로 확장할 수 있는 복잡한 API에 때때로 유용해요.
링크 (Links)
-
플러그인 문서의 Utility APIs 섹션
-
utility API에 대한 레거시 문서