פרויקט Ensembl
קל לארגן דפים בעזרת אוספים
אפשר לשמור ולסווג תוכן על סמך ההעדפות שלך.
בדף הזה מפורטים פרטי פרויקט של כתיבה טכנית שאושר להשתתפות בתוכנית 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 שמשמשות בקורס ההדרכה
הדפים הבאים
בהתאם למורכבות של הנושאים שמפורטים בדף הראשי, יכול להיות שחלק מהנושאים יצטרכו לקשר לדפי פרטים נוספים.
אלא אם צוין אחרת, התוכן של דף זה הוא ברישיון Creative Commons Attribution 4.0. לפרטים, ניתן לעיין במדיניות האתר Google Developers. Java הוא סימן מסחרי רשום של חברת Oracle ו/או של השותפים העצמאיים שלה.
עדכון אחרון: 2025-07-25 (שעון UTC).
[[["התוכן קל להבנה","easyToUnderstand","thumb-up"],["התוכן עזר לי לפתור בעיה","solvedMyProblem","thumb-up"],["סיבה אחרת","otherUp","thumb-up"]],[["חסרים לי מידע או פרטים","missingTheInformationINeed","thumb-down"],["התוכן מורכב מדי או עם יותר מדי שלבים","tooComplicatedTooManySteps","thumb-down"],["התוכן לא עדכני","outOfDate","thumb-down"],["בעיה בתרגום","translationIssue","thumb-down"],["בעיה בדוגמאות/בקוד","samplesCodeIssue","thumb-down"],["סיבה אחרת","otherDown","thumb-down"]],["עדכון אחרון: 2025-07-25 (שעון UTC)."],[],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
