API publiques et structure
Décidez ce que vous souhaitez exposer.
API publiques et structure est une leçon Mojo Academy gratuite sur CoddyKit. Ceci est la leçon 3 sur 4. Tu peux lire la leçon complète ci-dessous gratuitement — puis la pratiquer en direct dans le navigateur avec un éditeur de code intégré et un tuteur IA 24/7. Elle fait partie du parcours d'apprentissage Mojo Academy, et ta progression se synchronise sur le web et l'application CoddyKit. Le cours Mojo Academy comprend 4 leçons au total.
Ce que vous exposez compte
Une bonne bibliothèque se juge à sa surface. Décider ce qu’il faut exposer détermine la facilité d’utilisation de votre API. 🚪
Votre API publique
Les fonctions et les types que les autres codes sont censés appeler constituent votre API publique. C’est la promesse que vous faites à vos utilisateurs.
Les éléments internes restent cachés
Le code auxiliaire qui prend en charge votre API sans être destiné aux appelants est interne. Le cacher permet de garder une surface réduite.
Une surface réduite, moins de risques
Moins vous exposez de noms, plus la bibliothèque est facile à apprendre et plus vous pouvez modifier librement les éléments internes par la suite.
Réexporter depuis __init__
Le fichier __init__.mojo d’un paquet peut importer les noms importants afin que les utilisateurs y accèdent directement depuis le paquet, sans parcourir des fichiers imbriqués.
from .core import add, subtractUne porte d’entrée claire
En regroupant les imports dans __init__, vous fournissez aux appelants un point d’entrée unique et clair au lieu de chemins de modules longs et fragiles.
from mypkg import addMasquer l’organisation interne
Les utilisateurs importent depuis le paquet, et non depuis ses fichiers. Vous pouvez ainsi réorganiser les modules internes sans interrompre leur code.
Choisir des noms clairs
Les noms publics doivent être explicites. Un nom clair et stable fait partie du contrat que vous ne voulez pas modifier.
Documenter la surface
Ajoutez une chaîne de documentation à chaque fonction et type public. Une bonne documentation explique aux appelants comment utiliser correctement l’API.
fn add(a: Int, b: Int) -> Int:
"""Return the sum of a and b."""
return a + bDes promesses stables
Considérez votre API publique comme un contrat. La modifier peut interrompre le code des utilisateurs ; gardez-la donc réduite et réfléchissez avant de l’étendre.
Concevoir de l’extérieur vers l’intérieur
Imaginez d’abord comment un appelant souhaite utiliser votre bibliothèque, puis construisez les éléments internes pour offrir cette expérience claire. 🎨
Vérification rapide
Réfléchissons à la manière de garder une API facile à maintenir.
Récapitulatif
Exposez une API publique réduite et claire, réexportez les noms importants dans __init__, masquez les éléments internes et documentez ce que vous partagez. 🎯
Apprends Mojo avec un tuteur IA — gratuit
Écris et exécute du vrai code dans ton navigateur, obtiens de l'aide instantanée d'un tuteur IA disponible 24h/24, et reprends là où tu t'es arrêté sur le web ou dans l'app.
- Cours
- 30
- Leçons
- 120
Questions Fréquemment Posées
La leçon « API publiques et structure » est-elle gratuite ?
Oui — le texte complet de « API publiques et structure » est gratuit à lire ici sur le web. Pour la pratiquer de manière interactive (un éditeur de code intégré et un tuteur IA 24/7) et déverrouiller le reste du cours Mojo Academy, passe à CoddyKit PRO. Le cours Mojo Academy comprend 4 leçons au total.
Qu'est-ce que j'apprendrai dans « API publiques et structure » ?
Décidez ce que vous souhaitez exposer. Tu pratiques Mojo Academy avec du code pratique que tu exécutes directement dans le navigateur, et un tuteur IA 24/7 répond à tes questions au fur et à mesure que tu avances dans la leçon.
Dois-je avoir de l'expérience pour commencer Mojo Academy ?
Aucune expérience préalable n'est requise. Mojo Academy sur CoddyKit est structuré pour les débutants jusqu'aux apprenants avancés, donc tu peux commencer ici ou depuis le début et avancer à ton rythme. Ceci est la leçon 3 sur 4.
Combien de temps prend la leçon « API publiques et structure » ?
La plupart des leçons CoddyKit prennent environ 5–10 minutes. Chacune est courte et interactive, tu progresses régulièrement et tu repiques exactement où tu t'es arrêté sur le web et l'app.
Peux-tu écrire et exécuter du code dans cette leçon Mojo Academy ?
Oui. Chaque leçon Mojo Academy inclut un éditeur de code intégré, tu écris et exécutes du vrai code directement dans ton navigateur et tu reçois des retours IA instantanés — aucune configuration locale requise.
Toutes les leçons de ce cours
- Modules et imports
- Construire un .mojopkg
- API publiques et structure
- Bonnes pratiques d’organisation d’un projet