Angular Academy · Pelajaran

API Publik dan Titik Masuk

Rancang antarmuka pustaka yang rapi.

API Publik dan Titik Masuk adalah pelajaran Angular Academy gratis di CoddyKit. Ini adalah pelajaran 2 dari 4. Kamu bisa membaca pelajaran lengkapnya di bawah secara gratis — lalu praktikkan langsung di browser dengan editor kode bawaan dan tutor AI 24/7. Ini adalah bagian dari jalur belajar Angular Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Angular Academy mencakup 4 pelajaran total.

Permukaan API Publik

Pustaka seharusnya hanya mengekspos hal-hal yang memang dimaksudkan untuk digunakan oleh pengguna. API publik adalah kumpulan ekspor yang telah diseleksi; semua yang lain tetap internal. Dalam pustaka Angular, permukaan ini ditentukan oleh public-api.ts.

public-api.ts sebagai Barrel

public-api.ts mengekspor ulang simbol yang ingin Anda sediakan bagi pengguna. Jika sesuatu tidak diekspor di sini, hal tersebut secara efektif bersifat privat, meskipun ada di sumber.

// projects/ui-kit/src/public-api.ts
export * from './lib/button/button.component';
export * from './lib/theme.service';
// internal helpers are intentionally NOT exported

Alasan Menyembunyikan Internal

Menjadikan utilitas sebagai privat berarti Anda dapat mengubahnya secara bebas tanpa merusak pengguna. API publik yang kecil dan disengaja lebih mudah didokumentasikan, diberi versi, dan dipelihara daripada mengekspor semuanya.

Mengekspor Tipe dan Token

API publik tidak hanya mencakup komponen, tetapi juga antarmuka, tipe, dan token injeksi yang diperlukan pengguna agar dapat menggunakannya dengan benar.

export { ButtonComponent } from './lib/button/button.component';
export type { ButtonVariant } from './lib/button/button.types';
export { THEME_CONFIG } from './lib/theme.tokens';

Titik Entri Sekunder

Pustaka besar dibagi menjadi titik entri sekunder agar pengguna hanya mengimpor hal yang diperlukan (tree-shaking yang lebih baik). Contohnya, ui-kit/testing dipisahkan dari ui-kit.

import { ButtonComponent } from 'ui-kit';
import { provideUiKitTesting } from 'ui-kit/testing';

Membuat Titik Entri Sekunder

Titik entri sekunder adalah subfolder dengan ng-package.json dan public-api.ts sendiri. ng-packagr menemukannya secara otomatis dan membuild-nya sebagai jalur impor terpisah.

projects/ui-kit/
  testing/
    ng-package.json   # marks a secondary entry point
    src/public-api.ts

Pemetaan Titik Entri Utama

ng-package.json milik pustaka mengarahkan entryFile-nya ke public-api.ts, sehingga build mengetahui berkas yang menjadi permukaan publik utama.

// projects/ui-kit/ng-package.json
{
  "lib": { "entryFile": "src/public-api.ts" }
}

Merancang untuk Stabilitas

Perlakukan API publik seperti kontrak: menghapus atau mengganti nama ekspor merupakan perubahan yang merusak. Tambahkan ekspor baru dengan bebas, tetapi tandai sebagai usang sebelum menghapusnya agar pengguna memiliki waktu untuk bermigrasi.

Menghindari Impor Mendalam

Karena hanya public-api.ts yang menjadi kontrak, pengguna tidak boleh mengimpor jalur internal secara mendalam seperti ui-kit/lib/button/internal. Mengekspor melalui barrel mempertahankan satu permukaan impor yang stabil.

Mengekspor Ulang Tipe Pihak Ketiga

Jika metode API Anda mengembalikan tipe dari paket lain, ekspor ulang tipe tersebut agar pengguna tidak memerlukan dependensi terpisah hanya untuk menyebutkannya. Dengan demikian, permukaan publik tetap mandiri.

Mendokumentasikan Permukaan

Tambahkan komentar JSDoc ke simbol yang diekspor. Karena hanya item dalam public-api yang terlihat oleh pengguna, mendokumentasikannya akan memberikan IntelliSense dan panduan penggunaan yang jelas.

Pemeriksaan Singkat

Apa yang menentukan hal-hal yang dapat diimpor oleh pengguna?

Rangkuman

API publik diseleksi dalam public-api.ts, yang mengekspor ulang komponen, tipe, dan token; semua yang lain tetap privat dan dapat diubah strukturnya. Gunakan titik entri sekunder untuk pustaka besar, arahkan ng-package.json ke berkas entri, hindari impor mendalam, dan perlakukan permukaan tersebut sebagai kontrak yang stabil serta terdokumentasi.

Pertanyaan yang Sering Diajukan

Apakah pelajaran “API Publik dan Titik Masuk” gratis?

Ya — teks lengkap “API Publik dan Titik Masuk” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Angular Academy, upgrade ke CoddyKit PRO. Kursus Angular Academy mencakup 4 pelajaran total.

Apa yang akan aku pelajari di “API Publik dan Titik Masuk”?

Rancang antarmuka pustaka yang rapi. Kamu berlatih Angular Academy dengan kode praktik yang langsung kamu jalankan di browser, dan tutor AI 24/7 menjawab pertanyaanmu saat kamu mengerjakan pelajaran ini.

Apakah aku perlu pengalaman untuk memulai Angular Academy?

Tidak diperlukan pengalaman sebelumnya. Angular Academy di CoddyKit dirancang untuk pemula hingga pelajar tingkat lanjut, jadi kamu bisa memulai di sini atau dari awal dan belajar sesuai kecepatan kamu sendiri. Ini adalah pelajaran 2 dari 4.

Berapa lama pelajaran “API Publik dan Titik Masuk” memakan waktu?

Sebagian besar pelajaran CoddyKit memakan waktu sekitar 5–10 menit. Setiap pelajaran ringkas dan interaktif, jadi kamu membuat kemajuan stabil dan melanjutkan dari tempat kamu tinggalkan di web dan aplikasi.

Bisakah aku menulis dan menjalankan kode dalam pelajaran Angular Academy ini?

Ya. Setiap pelajaran Angular Academy menyertakan editor kode bawaan, jadi kamu menulis dan menjalankan kode nyata langsung di browser dan mendapatkan umpan balik AI instan — tidak diperlukan penyiapan lokal.

Semua pelajaran dalam kursus ini

← Kembali ke Angular Academy