API públicas y estructura
Decida qué exponer.
API públicas y estructura es una lección gratuita de Mojo Academy en CoddyKit. Esta es la lección 3 de 4. Puedes leer la lección completa abajo gratuitamente — luego la practicas en el navegador con un editor de código integrado y un tutor de IA 24/7. Forma parte de la ruta de aprendizaje de Mojo Academy, y tu progreso se sincroniza en la web y la app de CoddyKit. El curso de Mojo Academy incluye 4 lecciones en total.
Partes de esta lección aún no han sido traducidas y se muestran en 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. 🎯
Preguntas frecuentes
¿La lección «API públicas y estructura» es gratis?
Sí — el texto completo de «API públicas y estructura» es gratis para leer aquí en la web. Para practicarla de forma interactiva (editor de código integrado y tutor de IA 24/7) y desbloquear el resto del curso de Mojo Academy, actualiza a CoddyKit PRO. El curso de Mojo Academy incluye 4 lecciones en total.
¿Qué aprenderé en «API públicas y estructura»?
Decida qué exponer. Practicas Mojo Academy con código real que ejecutas directamente en el navegador, y un tutor de IA 24/7 responde tus preguntas mientras trabajas en la lección.
¿Necesito experiencia previa para empezar Mojo Academy?
No se requiere experiencia previa. Mojo Academy en CoddyKit está estructurado para principiantes hasta estudiantes avanzados, así que puedes empezar aquí o desde el inicio y avanzar a tu ritmo. Esta es la lección 3 de 4.
¿Cuánto tiempo toma la lección «API públicas y estructura»?
La mayoría de las lecciones de CoddyKit toman alrededor de 5–10 minutos. Cada una es compacta e interactiva, así que avanzas constantemente y retomas exactamente por donde dejaste en la web y la app.
¿Puedo escribir y ejecutar código en esta lección de Mojo Academy?
Sí. Cada lección de Mojo Academy incluye un editor de código integrado, así que escribes y ejecutas código real directamente en tu navegador y obtienes retroalimentación instantánea de IA — sin configuración local necesaria.
Todas las lecciones de este curso
- Módulos e imports
- Construir un .mojopkg
- API públicas y estructura
- Buenas prácticas para la estructura del proyecto