Merancang API Publik Kecil
Tentukan hal yang akan dibuka dan yang tetap internal
Merancang API Publik Kecil adalah pelajaran Kotlin Multiplatform Academy gratis di CoddyKit. Ini adalah pelajaran 1 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 Kotlin Multiplatform Academy, dan progresmu tersinkronisasi di web dan aplikasi CoddyKit. Kursus Kotlin Multiplatform Academy mencakup 4 pelajaran total.
Apa Itu API Publik
API publik modul Anda adalah kumpulan fungsi dan tipe yang boleh dipanggil oleh kode lain. Inilah pintu depan yang digunakan kedua aplikasi.
Permukaan Kecil Membawa Keuntungan
Permukaan yang kecil berarti lebih sedikit hal yang perlu dipelajari dan lebih sedikit hal yang bisa rusak. Ekspos hanya yang benar-benar dibutuhkan pemanggil, tidak lebih. 🎯
Mulai dari Kasus Penggunaan
Rancang dari belakang: tulis terlebih dahulu titik pemanggilan yang Anda inginkan. Biarkan penggunaan ideal itu membentuk tampilan fungsi publik Anda.
// Imagine this is how both apps will call you
val text = greeter.greet("Maya")Tampilkan Maksud, Sembunyikan Langkah
API yang baik menunjukkan maksud dan menyembunyikan langkah-langkahnya. Pemanggil menyatakan apa yang diinginkan, bukan cara pekerjaan itu dilakukan di dalam.
Beri Nama dengan Jelas
Nama yang jelas adalah separuh dari API Anda. Method bernama priceWithTax sudah menjelaskan semuanya tanpa dokumentasi tambahan.
fun priceWithTax(base: Double, rate: Double): Double {
return base + base * rate
}Utamakan Input Sederhana
Gunakan input yang biasa dan jelas, seperti string dan angka. Parameter sederhana membuat API mudah dipanggil dari Android maupun iOS.
Kembalikan Tipe yang Berguna
Kembalikan kelas data bersama, bukan nilai yang berdiri sendiri. Hasil bertipe dapat menjelaskan dirinya sendiri dan jauh lebih sulit disalahgunakan.
data class Quote(val total: Double, val currency: String)Sembunyikan Pembantu
Pembantu internal dan bagian yang belum rapi sebaiknya tetap privat. Hanya titik masuk yang benar-benar digunakan pemanggil yang menjadi bagian dari API publik.
Mudah Ditambahkan, Sulit Dihapus
Setiap hal publik adalah sebuah janji. Menambahkan API baru memang mudah, tetapi menghapusnya dapat merusak pemanggil, jadi sejak awal ekspos lebih sedikit.
Tetap Netral terhadap Platform
Jaga agar API tetap netral terhadap platform. Jika sebuah tanda tangan menyebutkan tipe Android atau iOS, API itu tidak dapat melayani kedua aplikasi dari kode bersama.
Rancang untuk Pembaca
API terbaik terbaca seperti kalimat di titik pemanggilan. Utamakan pemanggil, bukan orang yang menulis implementasinya.
Pemeriksaan Singkat
Mari uji naluri Anda dalam merancang API.
Ringkasan
API publik yang hebat berukuran kecil, memiliki nama yang jelas, dan dibentuk oleh kasus penggunaan nyata. Tampilkan maksud, sembunyikan langkah, dan kedua tim akan menyukainya. 🎉
Belajar Kotlin dengan tutor AI — gratis
Tulis dan jalankan kode asli di browser kamu, dapatkan bantuan instan dari tutor AI 24/7, dan lanjutkan di mana kamu tinggalkan di web atau aplikasi.
- Kursus
- 30
- Pelajaran
- 120
Pertanyaan yang Sering Diajukan
Apakah pelajaran “Merancang API Publik Kecil” gratis?
Ya — teks lengkap “Merancang API Publik Kecil” gratis dibaca di sini di web. Untuk praktiknya secara interaktif (editor kode bawaan dan tutor AI 24/7) dan buka sisa kursus Kotlin Multiplatform Academy, upgrade ke CoddyKit PRO. Kursus Kotlin Multiplatform Academy mencakup 4 pelajaran total.
Apa yang akan aku pelajari di “Merancang API Publik Kecil”?
Tentukan hal yang akan dibuka dan yang tetap internal Kamu berlatih Kotlin Multiplatform 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 Kotlin Multiplatform Academy?
Tidak diperlukan pengalaman sebelumnya. Kotlin Multiplatform 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 1 dari 4.
Berapa lama pelajaran “Merancang API Publik Kecil” 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 Kotlin Multiplatform Academy ini?
Ya. Setiap pelajaran Kotlin Multiplatform 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
- Merancang API Publik Kecil
- Visibilitas internal vs publik
- Mengatur Paket di Dalam Modul
- Mendokumentasikan API untuk Kedua Tim