Designe et lite offentlig API
Bestem hva som skal eksponeres, og hva som skal holdes internt
Designe et lite offentlig API er en gratis leksjon i Kotlin Multiplatform Academy på CoddyKit. Dette er leksjon 1 av 4. Du kan lese hele leksjonen gratis nedenfor – og deretter øve praktisk i nettleseren med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt. Den er en del av læringsløpet i Kotlin Multiplatform Academy, og fremdriften din synkroniseres mellom nettet og CoddyKit-appen. Kurset i Kotlin Multiplatform Academy inneholder totalt 4 leksjoner.
Hva et offentlig API er
Modulens public API er settet med funksjoner og typer som annen kode har lov til å kalle. Det er inngangsdøren begge appene går gjennom.
En liten overflate gir gevinst
Et lite overflateareal betyr færre ting å lære og færre ting som kan gå i stykker. Eksponer bare det kallere faktisk trenger, ikke mer. 🎯
Start med bruksområdet
Design baklengs: Skriv først kallstedet du skulle ønske du hadde. La denne ideelle bruken forme hvordan de public-funksjonene dine ser ut.
// Imagine this is how both apps will call you
val text = greeter.greet("Maya")Eksponer hensikten, skjul trinnene
Et godt API viser hensikten og skjuler trinnene. Kallere sier hva de vil ha, ikke hvordan arbeidet utføres internt.
Gi ting tydelige navn
Tydelige navn utgjør halvparten av API-et ditt. En metode som heter priceWithTax forteller hele historien uten at du trenger å lese mer dokumentasjon.
fun priceWithTax(base: Double, rate: Double): Double {
return base + base * rate
}Foretrekk enkle inputverdier
Ta imot enkle og tydelige inputverdier som strenger og tall. Enkle parametere gjør API-et lett å kalle fra både Android og iOS.
Returner nyttige typer
Returner delte dataklasser i stedet for løse verdier. Et typet resultat beskriver seg selv og er langt vanskeligere å bruke feil.
data class Quote(val total: Double, val currency: String)Skjul hjelpefunksjonene
Interne hjelpefunksjoner og uferdige kanter bør forbli private. Bare de inngangspunktene en kaller faktisk bruker, hører hjemme i det offentlige API-et.
Enkelt å legge til, vanskelig å fjerne
Alt som er public, er et løfte. Det er enkelt å legge til et nytt API senere, men fjerning kan ødelegge for kallere, så eksponer mindre fra starten.
Hold deg plattformuavhengig
Hold API-et plattformuavhengig. Hvis en signatur nevner Android- eller iOS-typer, kan den ikke betjene begge appene fra delt kode.
Design for leseren
De beste API-ene leses som en setning på kallstedet. Optimaliser for kalleren, ikke for den som skrev implementasjonen.
Hurtigsjekk
La oss teste instinktene dine for API-design.
Oppsummering
Et godt offentlig API er lite, har tydelige navn og er formet av virkelige bruksområder. Eksponer hensikten, skjul trinnene, så blir begge teamene fornøyde. 🎉
Lær deg Kotlin med en AI-veileder – gratis
Skriv og kjør ekte kode i nettleseren, få umiddelbar hjelp fra en AI-veileder som er tilgjengelig døgnet rundt, og fortsett der du slapp – på nettet eller i appen.
- Kurs
- 30
- Leksjoner
- 120
Ofte stilte spørsmål
Er leksjonen «Designe et lite offentlig API» gratis?
Ja – hele teksten i «Designe et lite offentlig API» er gratis å lese her på nettet. For å øve interaktivt med en innebygd kodeeditor og en AI-veileder som er tilgjengelig døgnet rundt, og for å låse opp resten av Kotlin Multiplatform Academy-kurset, kan du oppgradere til CoddyKit PRO. Kurset i Kotlin Multiplatform Academy inneholder totalt 4 leksjoner.
Hva lærer jeg i «Designe et lite offentlig API»?
Bestem hva som skal eksponeres, og hva som skal holdes internt Du øver på Kotlin Multiplatform Academy med praktisk kode som du kjører direkte i nettleseren, mens en AI-veileder som er tilgjengelig døgnet rundt, svarer på spørsmålene dine mens du jobber deg gjennom leksjonen.
Trenger jeg erfaring for å begynne med Kotlin Multiplatform Academy?
Ingen tidligere erfaring er nødvendig. Kotlin Multiplatform Academy på CoddyKit er lagt opp for både nybegynnere og viderekomne, så De kan begynne her eller helt fra start og lære i Deres eget tempo. Dette er leksjon 1 av 4.
Hvor lang tid tar leksjonen «Designe et lite offentlig API»?
De fleste CoddyKit-leksjoner tar omtrent 5–10 minutter. Hver leksjon er kort og interaktiv, slik at De gjør jevne fremskritt og kan fortsette akkurat der De slapp – både på nettet og i appen.
Kan jeg skrive og kjøre kode i denne Kotlin Multiplatform Academy-leksjonen?
Ja. Alle Kotlin Multiplatform Academy-leksjoner har en innebygd kodeeditor, slik at De kan skrive og kjøre ekte kode direkte i nettleseren og få umiddelbar tilbakemelding fra AI – uten lokal konfigurering.
Alle leksjonene i dette kurset
- Designe et lite offentlig API
- internal kontra public-synlighet
- Organisere pakker i modulen
- Dokumentere API-et for begge teamene