בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית Google Season of Docs.
סיכום הפרויקט
- ארגון קוד פתוח:
- מקבץ
- כותבים טכניים:
- laurelm
- שם הפרויקט:
- מאמרי העזרה של ה-API ל-REST
- אורך הפרויקט:
- אורך סטנדרטי (3 חודשים)
תיאור הפרויקט
שיפור המדריך למפתחים לשימוש ב-Ensembl REST API
המוקד העיקרי – הוספת קטע מבוא או 'תחילת העבודה' ידידותי יותר למשתמש.
ההטמעה המוצעת מבוססת על הדפים הבאים במסמכים:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
הדף הראשי:
כולל את הקטעים הבאים (תצוגה ברמה גבוהה):
סקירה כללית של מה שממשק ה-API הזה מספק בפועל
מבוא קצר ל-REST
דוגמה מהירה
פרטי אימות
מבוא לאופן שבו כתובות ה-URL מובנות באמצעות שיטות HTTP שונות
מידע על הפרמטרים הנדרשים והאופציונליים, והמקום שבו הם מופיעים במסמכי התיעוד של נקודות הקצה שנוצרו באופן אוטומטי.
קישור לדף ההדרכה הבא: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
מידע על פונקציות helper_functions שמשמשות בקורס ההדרכה
הדפים הבאים
בהתאם למורכבות של הנושאים שמפורטים בדף הראשי, יכול להיות שחלק מהנושאים יצטרכו לקשר לדפי פרטים נוספים.