דף זה מכיל את הפרטים של פרויקט כתיבה טכנית שהתקבל בעונה של Google 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 שנעשה בהם שימוש בקורס ההדרכה
הדפים הבאים
בהתאם למורכבות של הנושאים המפורטים בדף הראשי, ייתכן שיהיה צורך לקשר נושאים מסוימים לדפי הפרטים הבאים.