Angular Academy · Ders

Genel API ve Giriş Noktaları

Temiz bir kitaplık arayüzü tasarlayın

Genel API ve Giriş Noktaları, CoddyKit'te ücretsiz bir Angular Academy dersidir. Bu, 4 dersinin 2. dersidir. Aşağıdan dersin tamamını ücretsiz okuyabilir, sonra tarayıcıda yerleşik kod editörü ve 7/24 yapay zeka koçu ile uygulamalı olarak pratik yapabilirsin. Bu, Angular Academy öğrenme yolunun bir parçasıdır ve ilerlemeniz web ve CoddyKit uygulaması arasında senkronize olur. Angular Academy kursu toplamda 4 dersten oluşur.

Genel API Yüzeyi

Bir kitaplık, yalnızca tüketicilerin kullanması amaçlanan öğeleri dışa açmalıdır. Genel API, özenle seçilmiş dışa aktarmalar kümesidir; diğer her şey dahili kalır. Angular kitaplıklarında bu yüzey public-api.ts tarafından tanımlanır.

Barrel Olarak public-api.ts

public-api.ts, tüketicilerin erişmesini istediğiniz simgeleri yeniden dışa aktarır. Bir şey burada dışa aktarılmıyorsa, kaynak kodda bulunsa bile fiilen özeldir.

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

Dahili Öğeleri Neden Gizlemelisiniz

Yardımcıları özel tutmak, tüketicileri bozmadan bunları dilediğiniz gibi yeniden düzenleyebilmenizi sağlar. Küçük ve bilinçli bir genel API'yi belgelemek, sürümlendirmek ve bakımını yapmak, her şeyi dışa aktarmaktan daha kolaydır.

Türleri ve Belirteçleri Dışa Aktarma

Genel API yalnızca bileşenleri değil, tüketicilerin bunları doğru şekilde kullanmak için ihtiyaç duyduğu arayüzleri, türleri ve bağımlılık ekleme belirteçlerini de içerir.

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

İkincil Giriş Noktaları

Büyük kitaplıklar, tüketicilerin yalnızca ihtiyaç duyduklarını içe aktarması (daha iyi ağaç sarsma) için ikincil giriş noktalarına ayrılır. Örneğin ui-kit/testing, ui-kit'ten ayrı olabilir.

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

İkincil Giriş Noktası Oluşturma

İkincil giriş noktası, kendi ng-package.json ve public-api.ts dosyalarına sahip bir alt klasördür. ng-packagr bunu otomatik olarak bulur ve ayrı bir içe aktarma yolu olarak derler.

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

Ana Giriş Noktası Eşlemesi

Kitaplığın ng-package.json dosyası, entryFile alanını public-api.ts dosyasını gösterecek şekilde ayarlar ve derlemeye ana genel yüzeyin hangi dosya olduğunu bildirir.

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

Kararlılık İçin Tasarlama

Genel API'yi bir sözleşme olarak değerlendirin: bir dışa aktarmayı kaldırmak veya yeniden adlandırmak geriye dönük uyumluluğu bozan bir değişikliktir. Yeni dışa aktarmaları serbestçe ekleyin; ancak tüketicilerin geçiş yapabilmesi için kaldırmadan önce kullanımdan kaldırıldığını belirtin.

Derin İçe Aktarmalardan Kaçınma

Sözleşme yalnızca public-api.ts olduğundan tüketiciler ui-kit/lib/button/internal gibi dahili yolları hiçbir zaman derinlemesine içe aktarmamalıdır. Barrel üzerinden dışa aktarmak, tek ve kararlı bir içe aktarma yüzeyi sağlar.

Üçüncü Taraf Türlerini Yeniden Dışa Aktarma

API yönteminiz başka bir paketteki bir türü döndürüyorsa, tüketicilerin yalnızca bu türü adlandırmak için ayrı bir bağımlılığa ihtiyaç duymaması adına türü yeniden dışa aktarın. Böylece genel yüzey kendi başına yeterli olur.

Yüzeyi Belgeleme

Dışa aktarılan simgelere JSDoc yorumları ekleyin. Tüketiciler yalnızca genel API öğelerini görebildiğinden, bunları belgelemek kullanıcılara IntelliSense desteği ve nasıl kullanılacaklarına ilişkin açık yönergeler sağlar.

Kısa Kontrol

Tüketicilerin neleri içe aktarabileceğini ne tanımlar?

Özet

Genel API, bileşenleri, türleri ve belirteçleri yeniden dışa aktaran public-api.ts içinde düzenlenir; diğer her şey özel kalır ve yeniden düzenlenebilir. Büyük kitaplıklar için ikincil giriş noktaları kullanın, ng-package.json dosyasını giriş dosyasına yönlendirin, derin içe aktarmalardan kaçının ve bu yüzeyi kararlı, belgelenmiş bir sözleşme olarak değerlendirin.

Sıkça Sorulan Sorular

“Genel API ve Giriş Noktaları” dersi ücretsiz mi?

Evet — “Genel API ve Giriş Noktaları” dersin tüm metni burada web'de ücretsiz olarak okunabilir. Etkileşimli olarak pratik yapmak (yerleşik kod editörü ve 7/24 yapay zeka koçu) ve Angular Academy kursunun geri kalanını açmak için CoddyKit PRO'ya yükselt. Angular Academy kursu toplamda 4 dersten oluşur.

“Genel API ve Giriş Noktaları” dersinde ne öğreneceğim?

Temiz bir kitaplık arayüzü tasarlayın Angular Academy ile uygulamalı kodu tarayıcıda doğrudan çalıştırarak pratik yaparsın ve 7/24 yapay zeka koçu dersi çalışırken sorularını yanıtlar.

Angular Academy öğrenmeye başlamak için deneyim gerekli mi?

Önceden deneyim gerekmez. CoddyKit'te Angular Academy, başlangıçtan ileri seviyeye kadar yapılandırıldığı için buradan başlayabilir veya başından başlayıp kendi hızında ilerleme yapabilirsin. Bu, 4 dersinin 2. dersidir.

“Genel API ve Giriş Noktaları” dersi ne kadar sürer?

Çoğu CoddyKit dersi yaklaşık 5–10 dakika sürer. Her biri kısa ve etkileşimli olduğu için sabit ilerleme yaparsın ve web ile uygulama arasında tam olarak bıraktığın yerden devam edebilirsin.

Bu Angular Academy dersinde kod yazıp çalıştırabilir miyim?

Evet. Her Angular Academy dersi yerleşik bir kod editörü içerir, bu sayede tarayıcıda gerçek kod yazıp çalıştırabilir ve anlık yapay zeka geri bildirimi alırsın — yerel kurulum gerekli değildir.

Bu kursun tüm dersleri

← Angular Academy Sayfasına Dön