APIs públicas e estrutura
Decida o que expor.
APIs públicas e estrutura é uma aula grátis de Mojo Academy no CoddyKit. Esta é a aula 3 de 4. Você pode ler a aula completa abaixo gratuitamente — depois pratica ao vivo no navegador com um editor de código integrado e um tutor de IA 24/7. Faz parte do caminho de aprendizado de Mojo Academy, e seu progresso é sincronizado entre a web e o app CoddyKit. O curso de Mojo Academy inclui 4 aulas no total.
Partes desta aula ainda não foram traduzidas e aparecem em inglês.
What You Show Matters
A good library is judged by its surface. Deciding what to expose shapes how easy your API is to use. 🚪
Your Public API
The functions and types other code is meant to call form your public API. It is the promise you keep to users.
Internals Stay Hidden
Helper code that supports your API but is not meant for callers is internal. Hiding it keeps your surface small.
Smaller Surface, Less Risk
The fewer names you expose, the easier the library is to learn and the more freely you can change internals later.
Re-export From __init__
A package's __init__.mojo can import key names so users reach them straight from the package, not deep files.
from .core import add, subtractA Clean Front Door
By gathering imports in __init__, you give callers one clear entry point instead of long, fragile module paths.
from mypkg import addHide the Layout
Users import from the package, not its files. That lets you rearrange inner modules without breaking their code.
Name Things Clearly
Public names should be self-explanatory. A clear, stable name is part of the contract you do not want to change.
Document the Surface
Add a docstring to each public function and type. Good docs tell callers how to use the API correctly.
fn add(a: Int, b: Int) -> Int:
"""Return the sum of a and b."""
return a + bStable Promises
Treat your public API as a contract. Changing it can break users, so keep it small and think before you grow it.
Design From Outside In
Picture how a caller wants to use your library first, then build the internals to serve that clean experience. 🎨
Quick Check
Let us think about keeping an API easy to maintain.
Recap
Expose a small, clear public API, re-export key names in __init__, hide internals, and document what you share. 🎯
Perguntas Frequentes
A aula “APIs públicas e estrutura” é grátis?
Sim — o texto completo de “APIs públicas e estrutura” é grátis para ler aqui na web. Para praticá-la interativamente (um editor de código integrado e um tutor de IA 24/7) e desbloquear o restante do curso de Mojo Academy, atualize para CoddyKit PRO. O curso de Mojo Academy inclui 4 aulas no total.
O que vou aprender em “APIs públicas e estrutura”?
Decida o que expor. Você pratica Mojo Academy com código prático que executa diretamente no navegador, e um tutor de IA 24/7 responde suas dúvidas enquanto trabalha na aula.
Preciso ter experiência prévia para começar Mojo Academy?
Nenhuma experiência prévia é necessária. Mojo Academy no CoddyKit é estruturado para alunos iniciantes até avançados, então você pode começar aqui ou desde o início e aprender no seu ritmo. Esta é a aula 3 de 4.
Quanto tempo leva a aula “APIs públicas e estrutura”?
A maioria das aulas CoddyKit leva cerca de 5–10 minutos. Cada uma é compacta e interativa, então você faz progresso constante e retoma exatamente de onde parou entre web e app.
Posso escrever e executar código nesta aula de Mojo Academy?
Sim. Cada aula de Mojo Academy inclui um editor de código integrado, então você escreve e executa código real direto no navegador e recebe feedback de IA instantaneamente — nenhuma configuração local necessária.
Todas as aulas deste curso
- Módulos e importações
- Construindo um .mojopkg
- APIs públicas e estrutura
- Práticas recomendadas de organização de projetos