تحتوي هذه الصفحة على تفاصيل مشروع كتابة فنية تم قبوله في "موسم مستندات Google".
ملخص المشروع
- مؤسسة مفتوحة المصدر:
- Ensembl
- الكاتب الفني:
- laurelm
- اسم المشروع:
- مستندات REST API
- مدة المشروع:
- المدة العادية (3 أشهر)
وصف المشروع
تحسين دليل المستخدم للمطوّرين لاستخدام Ensembl REST API
التركيز الرئيسي -- توفير مقدمة أكثر سهولة في الاستخدام/قسم الخطوات الأولى.
يعتمد التنفيذ المقترح على أسطر صفحات المستند هذه:
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
معلومات عن الدوال المساعدة المستخدَمة في الدورة التدريبية
الصفحات اللاحقة
قد تحتاج بعض المواضيع إلى الربط بصفحات التفاصيل اللاحقة بناءً على مدى تعقيد المواضيع المدرَجة في الصفحة الرئيسية.