تحتوي هذه الصفحة على تفاصيل مشروع كتابة فني مقبول في موسم Google من المستندات.
ملخّص المشروع
- مؤسسة مفتوحة المصدر:
- OpenMRS.org
- الكاتب التقني:
- batbrain7
- اسم المشروع:
- مستندات واجهة برمجة التطبيقات OpenMRS REST
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
سأقسّم اقتراحنا إلى أقسام مختلفة وسنتبع الخطوات الواردة في مستندات Google Maps API ومستندات Github API.
بالإضافة إلى ذلك، أودّ أيضًا اقتراح بنية readme لمستندات واجهة برمجة التطبيقات التي أنشأتها realworld.io: https://github.com/gothinkster/realworld/tree/master/api
أنا شخصيًا وجدت هذه المستندات سهلة الفهم والاستخدام.
سيتكون اقتراحي بشكل أساسي من 3 أقسام :
قسم يقدّم مقدمة سريعة عن واجهة برمجة التطبيقات وOpenMRS وكيفية استخدام واجهة برمجة التطبيقات وما يترتب على ذلك
كيفية الحصول على مفتاح واجهة برمجة التطبيقات والمصادقة المطلوبة بشكل عام لتقديم طلب البيانات من واجهة برمجة التطبيقات سيتضمّن ذلك نموذجًا لأنواع المصادقة المتوفّرة في واجهة برمجة التطبيقات والمفاتيح والقيم التي يجب أن تكون متوفّرة لها، بالإضافة إلى أنواع القيم المقبولة التي تتوافق مع المفتاح في ذلك الجزء. من خلال نموذج التعليمات البرمجية بأي لغة، يمكن توضيح طريقة كتابة العناوين وتنسيقات الردود ومعلَمات طلب البحث الأخرى في واجهة برمجة التطبيقات.
يجب ذكر أنواع الردود التي تحصل عليها واجهة برمجة التطبيقات أو أنواع ملفات JSON أو أي نوع آخر من النتائج التي تعرضها واجهات برمجة التطبيقات.
مسارات واجهة برمجة التطبيقات المختلفة والمَعلمات التي يجب إرسالها مع هذه المسارات والرؤوس والعناصر الأخرى سيتمّ تقديم عيّنات رموز برمجية لكلّ واجهة برمجة تطبيقات بعدّة لغات توضّح كيفية تقديم الطلب أثناء كتابة الرمز البرمجي له، بالإضافة إلى ذلك، يجب أيضًا الإشارة إلى رموز الخطأ العامة التي يمكن مواجهتها مع كلّ واجهة برمجة تطبيقات.
إليك فكرة عامة عن كيفية تحديد المستندات لواجهة برمجة التطبيقات REST API.
الجدول الزمني للمشروع هو كما يلي :
من 1 آب (أغسطس) إلى 1 أيلول (سبتمبر)
التعرّف على المرشد ومناقشة مستوى التوثيق المطلوب بالتفصيل في أجزاء مختلفة من قاعدة البيانات، ومناقشة مدى التعمّق في التوثيق على مستوى منخفض مقارنةً بالتوثيق على مستوى عالٍ سأقضي أيضًا هذه الفترة في فهم قاعدة البيانات ودراسة المفاهيم حتى أتمكّن من توثيقها بشكل أفضل.
الأسبوعان 1 و2
سأعدّل دليل المساهمين وسنوسّع نطاقه. سأعمل على تحسين المستندات حول كيفية إنشاء رمز المصدر. سأضيف أيضًا قسمًا للموثّقين حول كيفية مساعدة المساهمين الجدد في التوثيق. سأدرس وثائق واجهة برمجة التطبيقات المختلفة وأبدأ بالمقدمة وأضيف المصادقة إلى واجهة برمجة التطبيقات.
من الأسبوع 3 إلى 8
سأضيف مسارات واجهة برمجة التطبيقات واستجاباتها إلى جانب بعض نماذج الرموز لكل نوع من واجهات برمجة التطبيقات (قد تكون هناك أنواع مشابهة من واجهات برمجة التطبيقات).
الأسبوع 9 و10
أضِف بنية مستندات واجهة برمجة التطبيقات باستخدام الروابط، أي فهرس مرتبط لمستندات واجهة برمجة التطبيقات الطويلة، وقسِّمها بشكل أكبر استنادًا إلى أساس مختلف، مثل أقسام الرموز البرمجية والنظرة العامة والمَعلمات ونقاط النهاية الجذر.
الأسبوع الأخير
سأستخدِم الأسبوع الأخير لإعداد تقريري النهائي عن العمل الذي تمّ خلال فترة التوثيق التي تبلغ 12 أسبوعًا. سأستخدِم هذا الوقت أيضًا لمراجعة المستندات ووضع اللمسات النهائية عليها.