공개 API와 진입점
깔끔한 라이브러리 표면을 설계합니다.
공개 API와 진입점은(는) CoddyKit의 무료 Angular Academy 강의입니다. 이것은 4개 중 2번째 강의입니다. 아래에서 전체 강의를 무료로 읽을 수 있으며, 내장 코드 에디터와 24/7 AI 튜터와 함께 브라우저에서 직접 실습할 수 있습니다. 이 강의는 Angular Academy 학습 경로의 일부이며, 진행 상황이 웹과 CoddyKit 앱에 동기화됩니다. Angular Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
공개 API 영역
라이브러리는 사용자가 사용하도록 의도된 항목만 노출해야 합니다. 공개 API는 엄선된 내보내기 항목의 집합이며, 나머지는 모두 내부에 유지됩니다. 앵귤러 라이브러리에서는 이 영역을 public-api.ts로 정의합니다.
배럴로서의 public-api.ts
public-api.ts는 사용자가 접근할 수 있도록 하려는 기호를 다시 내보냅니다. 이곳에서 내보내지 않은 항목은 소스에 존재하더라도 사실상 비공개입니다.
// projects/ui-kit/src/public-api.ts
export * from './lib/button/button.component';
export * from './lib/theme.service';
// internal helpers are intentionally NOT exported내부 구현을 숨기는 이유
도우미를 비공개로 유지하면 사용자를 중단시키지 않고 자유롭게 리팩터링할 수 있습니다. 작고 신중하게 구성된 공개 API는 모든 것을 내보내는 것보다 문서화, 버전 관리, 유지 관리가 쉽습니다.
형식과 토큰 내보내기
공개 API에는 구성 요소뿐 아니라 사용자가 구성 요소를 올바르게 사용하는 데 필요한 인터페이스, 형식, 주입 토큰도 포함됩니다.
export { ButtonComponent } from './lib/button/button.component';
export type { ButtonVariant } from './lib/button/button.types';
export { THEME_CONFIG } from './lib/theme.tokens';보조 진입점
대규모 라이브러리는 보조 진입점으로 나누어 사용자가 필요한 항목만 가져오도록 합니다(트리 셰이킹 개선). 예를 들어 ui-kit/testing을 ui-kit과 분리할 수 있습니다.
import { ButtonComponent } from 'ui-kit';
import { provideUiKitTesting } from 'ui-kit/testing';보조 진입점 만들기
보조 진입점은 자체 ng-package.json과 public-api.ts를 가진 하위 폴더입니다. ng-packagr이 이를 자동으로 찾아 별도의 가져오기 경로로 빌드합니다.
projects/ui-kit/
testing/
ng-package.json # marks a secondary entry point
src/public-api.ts주 진입점 매핑
라이브러리의 ng-package.json은 entryFile을 public-api.ts로 지정하여, 빌드에서 어떤 파일을 주요 공개 영역으로 사용할지 알려 줍니다.
// projects/ui-kit/ng-package.json
{
"lib": { "entryFile": "src/public-api.ts" }
}안정성을 고려한 설계
공개 API를 계약처럼 다루세요. 내보내기 항목을 제거하거나 이름을 바꾸면 호환성이 깨지는 변경입니다. 새 내보내기 항목은 자유롭게 추가하되, 제거하기 전에 사용 중단을 표시하여 사용자가 마이그레이션할 시간을 주세요.
깊은 가져오기 피하기
계약은 public-api.ts에만 정의되므로 사용자는 ui-kit/lib/button/internal 같은 내부 경로를 깊게 가져와서는 안 됩니다. 배럴을 통해 내보내면 안정적인 단일 가져오기 영역을 유지할 수 있습니다.
서드 파티 형식 다시 내보내기
API 메서드가 다른 패키지의 형식을 반환한다면, 사용자가 해당 형식의 이름을 지정하기 위해 별도의 의존성을 추가하지 않도록 그 형식을 다시 내보내세요. 그러면 공개 영역이 자체적으로 완결됩니다.
공개 영역 문서화
내보낸 기호에 JSDoc 주석을 추가하세요. 사용자에게 공개되는 항목은 public-api 항목뿐이므로, 이를 문서화하면 IntelliSense와 명확한 사용 지침을 제공할 수 있습니다.
빠른 확인
사용자가 가져올 수 있는 항목을 정의하는 것은 무엇인가요?
요약
공개 API는 public-api.ts에서 관리되며, 이 파일은 구성 요소, 형식, 토큰을 다시 내보냅니다. 나머지는 모두 비공개로 유지되어 자유롭게 리팩터링할 수 있습니다. 대규모 라이브러리에는 보조 진입점을 사용하고, ng-package.json이 진입 파일을 가리키도록 하며, 깊은 가져오기를 피하고, 공개 영역을 안정적이고 문서화된 계약으로 다루세요.
자주 묻는 질문
“공개 API와 진입점” 강의는 무료인가요?
네 — “공개 API와 진입점” 전체 내용을 이 웹사이트에서 무료로 읽을 수 있습니다. 인터랙티브하게 실습하려면(내장 코드 에디터와 24/7 AI 튜터), CoddyKit PRO로 업그레이드하면 Angular Academy 강의 전체를 잠금 해제할 수 있습니다. Angular Academy 강의에는 총 4개의 강의가 포함되어 있습니다.
“공개 API와 진입점”에서 뭘 배우나요?
깔끔한 라이브러리 표면을 설계합니다. 브라우저에서 직접 실행하는 실습 코드로 Angular Academy을(를) 배우며, 24/7 AI 튜터가 강의를 진행하면서 질문에 답변해줍니다.
Angular Academy을(를) 시작하는 데 경험이 필요한가요?
사전 경험은 필요하지 않습니다. CoddyKit의 Angular Academy은(는) 초급자부터 고급 학습자까지를 위해 구성되어 있으므로, 여기서 시작하거나 처음부터 시작할 수 있으며 자신의 속도대로 진행할 수 있습니다. 이것은 4개 중 2번째 강의입니다.
“공개 API와 진입점” 강의는 얼마나 걸리나요?
대부분의 CoddyKit 강의는 약 5~10분이 소요됩니다. 각 강의는 간결하고 인터랙티브하여 꾸준한 진행이 가능하며, 웹과 앱에서 중단한 부분부터 바로 시작할 수 있습니다.
이 Angular Academy 강의에서 코드를 작성하고 실행할 수 있나요?
네. 모든 Angular Academy 강의에는 내장 코드 에디터가 포함되어 있으므로, 브라우저에서 바로 실제 코드를 작성하고 실행한 후 즉시 AI 피드백을 받을 수 있습니다 — 로컬 설정이 필요 없습니다.