公共 API 与结构
决定要公开哪些内容
公共 API 与结构 是 CoddyKit 上的免费 Mojo Academy 课时。 这是第 3 节课，共 4 节。 你可以在下方免费阅读本课时的完整内容 — 然后在浏览器中使用内置代码编辑器和全天候 AI 导师进行实践。 这是 Mojo Academy 学习路径的一部分，你的进度在网页和 CoddyKit 应用中同步。 Mojo Academy 课程共包含 4 节课。
展示什么很重要
一个优秀的库取决于它呈现出来的表面。决定要公开哪些内容，会影响您的API是否易于使用。🚪
您的公共 API
供其他代码调用的函数和类型构成您的公共 API。这是您向用户作出的承诺。
隐藏内部实现
支持 API 但不供调用者直接使用的辅助代码属于内部实现。隐藏这些内容可以保持较小的接口表面。
表面越小，风险越低
公开的名称越少，库就越容易学习，而且您之后可以更自由地修改内部实现。
从 __init__ 重新导出
包的 __init__.mojo 可以导入关键名称，让用户直接从包中访问它们，而不必深入文件层级。
from .core import add, subtract简洁的入口
将导入内容集中到 __init__ 中，可以为调用者提供一个清晰的入口点，而不是冗长且脆弱的模块路径。
from mypkg import add隐藏内部布局
用户应从包中导入内容，而不是从其中的文件导入。这样，您就可以重新安排内部模块，而不会破坏用户的代码。
清晰命名
公共名称应当一目了然。清晰而稳定的名称是您不希望随意更改的契约组成部分。
记录接口表面
为每个公共函数和类型添加文档字符串。优秀的文档会告诉调用者如何正确使用 API。
fn add(a: Int, b: Int) -> Int:
"""Return the sum of a and b."""
return a + b稳定的承诺
将公共 API 视为一份契约。修改它可能会破坏用户的代码，因此应保持其小巧，并在扩展之前认真考虑。
从外向内设计
先设想调用者希望如何使用您的库，然后构建内部实现来提供这种简洁的体验。🎨
快速检查
让我们思考一下如何保持 API 易于维护。
回顾
公开小巧清晰的公共 API，在 __init__ 中重新导出关键名称，隐藏内部实现，并记录您共享的内容。🎯
用 AI 导师学习 Mojo — 免费
在浏览器中编写并运行真实代码，获得全天候 AI 导师的即时帮助，并在网页或应用中继续学习。
- 课程
- 30
- 课程
- 120
常见问题解答
「公共 API 与结构」课时是免费的吗？
是的 — 「公共 API 与结构」的完整文本可在网页上免费阅读。要进行交互式练习（内置代码编辑器和全天候 AI 导师）并解锁 Mojo Academy 课程的其余内容，请升级到 CoddyKit PRO。 Mojo Academy 课程共包含 4 节课。
「公共 API 与结构」这节课中我会学到什么？
决定要公开哪些内容 你通过在浏览器中直接运行的动手代码来练习 Mojo Academy，全天候 AI 导师会在你学习这节课的过程中回答你的问题。
学习 Mojo Academy 需要有经验吗？
无需任何先前经验。CoddyKit 上的 Mojo Academy 课程适合初学者到高级学习者，你可以从这里开始或从头开始，按照自己的节奏学习。 这是第 3 节课，共 4 节。
「公共 API 与结构」课时需要多长时间？
大多数 CoddyKit 课程大约需要 5–10 分钟。每节课都很精短且互动，所以你能稳步进步，并在网页和应用中从离开的地方继续。
我能在这节 Mojo Academy 课中编写并运行代码吗？
能。每节 Mojo Academy 课都包含内置代码编辑器，你可以在浏览器中直接编写并运行真实代码，并获得即时 AI 反馈 — 无需本地设置。
此课程中的所有课时
- 模块与导入
- 构建 .mojopkg
- 公共 API 与结构
- 项目布局最佳实践