واجهات API العامة والبنية
حدّد ما تريد إتاحته
واجهات API العامة والبنية درس مجاني في Mojo Academy على CoddyKit. هذا هو الدرس 3 من أصل 4. يمكنك قراءة الدرس كاملاً أدناه مجاناً — ثم تمرن عليه مباشرة في المتصفح باستخدام محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7. هذا الدرس جزء من مسار التعلم في 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__، وأخفوا التفاصيل الداخلية، ووثّقوا ما تشاركونه. 🎯
الأسئلة الشائعة
هل درس «واجهات API العامة والبنية» مجاني؟
نعم — نص درس «واجهات API العامة والبنية» كامل متاح مجاناً هنا على الويب. لتمرينه بشكل تفاعلي (محرر أكواد مدمج ومدرس ذكاء اصطناعي متاح 24/7) وفتح باقي دورة Mojo Academy، انتقل إلى CoddyKit PRO. تتضمن دورة Mojo Academy 4 دروس في المجموع.
ماذا ستتعلم في «واجهات API العامة والبنية»؟
حدّد ما تريد إتاحته تتمرن على Mojo Academy مع أكواد عملية تشغلها مباشرة في المتصفح، ومدرس ذكاء اصطناعي متاح 24/7 يجيب على أسئلتك أثناء عملك.
هل أحتاج إلى خبرة سابقة لأبدأ Mojo Academy؟
لا تُشترط خبرة سابقة. Mojo Academy على CoddyKit منظم للمبتدئين حتى المتقدمين، لذا يمكنك البدء من هنا أو من البداية والتقدم بسرعتك الخاصة. هذا هو الدرس 3 من أصل 4.
كم من الوقت يستغرق درس «واجهات API العامة والبنية»؟
معظم دروس CoddyKit تستغرق حوالي 5–10 دقائق. كل منها موجز وتفاعلي، لذا تحرز تقدماً مستمراً وتستأنف من حيث توقفت عبر الويب والتطبيق.
هل يمكنني كتابة وتشغيل أكواد في درس Mojo Academy هذا؟
نعم. كل درس في Mojo Academy يتضمن محرر أكواد مدمج، لذا تكتب وتشغل أكواداً حقيقية مباشرة في متصفحك وتحصل على تعليقات فورية من الذكاء الاصطناعي — بدون إعداد محلي.
جميع الدروس في هذه الدورة
- الوحدات وعمليات الاستيراد
- بناء .mojopkg
- واجهات API العامة والبنية
- أفضل ممارسات تخطيط المشروع