تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- OpenMRS.org
- الكاتب الفني:
- Ayeshmantha
- اسم المشروع:
- إنشاء مستندات GithHub سهلة الاستخدام لواجهة برمجة التطبيقات REST API
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
يتمثل الهدف الأساسي من المشروع في تطوير مستندات تفاعلية يمكن للمستخدمين النهائيين من خلالها التفاعل مع واجهات برمجة التطبيقات باستخدام خيارات التجربة، وفي الوقت نفسه الحصول على وصف أكثر وصفًا وشرحًا ذاتيًا يوضّح للمستخدمين التقنيين وغير التقنيين الحالات التي يجب فيها استخدام نقطة النهاية.
البيئة المهذبة الحالية رائعة ولكن بالنسبة لغير التقنيين والتقنيين لا يزال من الصعب الحصول على فكرة مباشرة دون التوثيق المناسب. الفكرة الرئيسية هي الحصول على بيئة swagger والوثائق في مكان واحد مع تمثيل جيد. باستخدام JavaScript وHTML وCSS