API 계약

각 마이크로 프론트엔드는 의견, 로직 및 복잡성을 캡슐화할 수 있는 시스템입니다. 교차 절단 문제에는 일반적으로 다음이 포함됩니다.

• 시스템 설계 ‒ 라이브러리로 배포된 UIs를 개발하기 위한 도구

• 구성 ‒ 마이크로 프런트엔드가 애플리케이션 셸과 상호 작용하여 컨텍스트를 렌더링하고 상속해야 하는 방식

• 로직 처리 ‒ 영구 상태를 처리하기 위한 APIs와의 상호 작용

• 다른 마이크로 프론트엔드와의 상호 작용 - 이벤트를 게시 및 소비하거나 한 마이크로 프론트엔드에서 다른 마이크로 프론트엔드로 이동하는 등의 시나리오

소비 및 문제 해결을 가속화하기 위해 마이크로 프런트엔드 종속성을 포함하여 이러한 인터페이스가 선언되고 문서화되는 방식을 표준화하는 데 투자하는 것이 일반적입니다. 사람이 큐레이션한 Wiki는 좋은 출발점입니다. 보다 확장 가능한 접근 방식은이 정보를 코드에 구조화된 메타데이터로 저장하는 것입니다. 그런 다음 자동화를 사용하여 과거 변경 사항을 추적하고 전체 텍스트 검색을 제공하여 사용을 위해 중앙 집중화할 수 있습니다.

마이크로 프론트엔드에 많은 팀이 포함되는 경우 팀 간에 조정하기 위한 전략이 필요합니다. 통합 방식으로 API 계약을 공유하는 것은 통신 오버헤드를 줄이고 개발자 경험을 개선하므로 필수가 됩니다.

OpenAPI는 통합 방식으로 APIs 인터페이스 및 계약을 정의하는 것을 지원하는 HTTP API용 사양 언어입니다. Amazon APIs를 사용하여 REST API를 구현할 수 있습니다. OpenAPI Amazon API Gateway 컨테이너 또는 가상 머신에서 호스팅할 수 있는 다양한 오픈 소스 프레임워크를 사용할 수도 있습니다. 중요한 이점은 OpenAPI가 일관된 형식으로 설명서를 자동으로 생성할 수 있으므로 여러 팀이 최소한의 초기 투자로 지식을 공유할 수 있다는 것입니다.

여러 팀이 마이크로 프런트엔드에서 작업할 때 종종 그룹을 형성합니다. 이러한 그룹에서는 사람들이 서로 만나서 배우면서 더 큰 그림에 대해 생각하고 기여할 수 있습니다. 이러한 이니셔티브는 일반적으로 소유권 경계를 정의 및 문서화하고, 교차 해결 문제를 논의하며, 일반적인 문제를 해결하기 위한 노력의 중복을 조기에 식별합니다.