设计小型公共 API
决定哪些内容公开，哪些内容保持内部
设计小型公共 API 是 CoddyKit 上的免费 Kotlin Multiplatform Academy 课时。 这是第 1 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Kotlin Multiplatform Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Kotlin Multiplatform Academy 课程共包含 4 节课。
本课时的部分内容尚未翻译，以英文显示。
What a Public API Is
Your module's public API is the set of functions and types other code is allowed to call. It is the front door both apps walk through.
Small Surface Wins
A small surface area means fewer things to learn and fewer things to break. Expose only what callers truly need, nothing more. 🎯
Start From the Use Case
Design backwards: write the call site you wish you had first. Let that ideal usage shape what your public functions look like.
// Imagine this is how both apps will call you
val text = greeter.greet("Maya")Expose Intent, Hide Steps
A good API shows the intent and hides the steps. Callers say what they want, not how the work gets done inside.
Name Things Clearly
Clear names are half your API. A method called priceWithTax tells the whole story without any extra docs to read.
fun priceWithTax(base: Double, rate: Double): Double {
return base + base * rate
}Prefer Simple Inputs
Take plain, obvious inputs like strings and numbers. Simple parameters make your API easy to call from both Android and iOS.
Return Useful Types
Return shared data classes instead of loose values. A typed result is self-describing and far harder to misuse.
data class Quote(val total: Double, val currency: String)Hide the Helpers
Internal helpers and rough edges should stay private. Only the entry points a caller actually uses belong in the public API.
Easy to Add, Hard to Remove
Every public thing is a promise. It is easy to add new API later, but removing it can break callers, so expose less up front.
Stay Platform-Neutral
Keep the API platform-neutral. If a signature mentions Android or iOS types, it cannot serve both apps from shared code.
Design for the Reader
The best APIs read like a sentence at the call site. Optimize for the caller, not for whoever wrote the implementation.
Quick Check
Let's test your API design instincts.
Recap
A great public API is small, clearly named, and shaped by real use cases. Expose intent, hide steps, and both teams will love it. 🎉
用 AI 导师学习 Kotlin — 免费
在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。
- 课程
- 30
- 课程
- 120
常见问题解答
「设计小型公共 API」课时是免费的吗？
是的 — 「设计小型公共 API」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Kotlin Multiplatform Academy 课程的其余内容，请升级到 CoddyKit PRO。 Kotlin Multiplatform Academy 课程共包含 4 节课。
「设计小型公共 API」这节课中我会学到什么？
决定哪些内容公开，哪些内容保持内部 你通过在浏览器中直接运行的动手代码来练习 Kotlin Multiplatform Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Kotlin Multiplatform Academy 需要有经验吗？
无需任何先前经验。CoddyKit 上的 Kotlin Multiplatform Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 1 节课，共 4 节。
「设计小型公共 API」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 Kotlin Multiplatform Academy 课中编写并运行代码吗？
能。每节 Kotlin Multiplatform Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。