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