تحتوي هذه الصفحة على تفاصيل مشروع كتابة تقنيّة تم قبوله في موسم المستندات من Google.
ملخص المشروع
- المؤسسة المفتوحة المصدر:
- التجميع
- الكاتب التقني:
- لورلم
- اسم المشروع:
- وثائق ReST API
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تحسين دليل المستخدم لمطوّري البرامج لاستخدام واجهة برمجة التطبيقات Ensembl REST
التركيز الرئيسي -- تقديم مقدمة أكثر سهولة في الاستخدام وقسم خطوات البدء.
ويستند التنفيذ المقترح إلى سطور صفحات المستند التالية:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
الصفحة الرئيسية:
تتضمن هذه الأقسام (عرض عالي المستوى):
نظرة عامة على ما تقدّمه واجهة برمجة التطبيقات من الناحية العملية
مقدمة قصيرة عن REST
مثال سريع
معلومات المصادقة
مقدمة حول كيفية تنظيم عناوين URL باستخدام طرق HTTP المختلفة
معلومات عن المَعلمات المطلوبة والاختيارية ومكان العثور عليها في مستندات نقاط النهاية التي يتم إنشاؤها تلقائيًا.
رابط إلى صفحة التدريب التالية: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
معلومات عن دوال helper_التي يتم استخدامها في الدورة التدريبية
الصفحات اللاحقة
وبناءً على مدى تعقيد المواضيع المدرَجة في الصفحة الرئيسية، قد تحتاج بعض المواضيع إلى ربطها بصفحات تتضمّن تفاصيل لاحقة.