پروژه آنسامبل
با مجموعهها، منظم بمانید
ذخیره و طبقهبندی محتوا براساس اولویتهای شما.
این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد Google پذیرفته شده است.
خلاصه پروژه
- سازمان منبع باز:
- گروه
- نویسنده فنی:
- لورلم
- نام پروژه:
- مستندات 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
صفحه اصلی:
شامل این بخش ها (نمای سطح بالا):
مروری بر آنچه که این API در شرایط عملی ارائه می دهد
معرفی کوتاه REST
یک مثال سریع
اطلاعات احراز هویت
مقدمه ای بر چگونگی ساختار URL ها با استفاده از روش های مختلف HTTP
اطلاعات مربوط به پارامترهای مورد نیاز و اختیاری و جایی که آنها در مستندات نقطه پایانی تولید شده به طور خودکار یافت می شوند.
لینک صفحه آموزش زیر: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
اطلاعاتی در مورد helper_functions که در دوره آموزشی استفاده می شود
صفحات بعدی
بسته به پیچیدگی موضوعات فهرست شده در صفحه اصلی، برخی از موضوعات ممکن است نیاز به پیوند به صفحات جزئیات بعدی داشته باشند.
محتوای این صفحه تحت مجوز Creative Commons Attribution 4.0 License است، مگر غیر از این ذکر شده باشد. برای اطلاع از جزئیات، به خطمشیهای سایت Google Developers مراجعه کنید. جاوا علامت تجاری ثبتشده Oracle و/یا شرکتهای وابسته به آن است.
تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی.
[[["درک آسان","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"]],["تاریخ آخرین بهروزرسانی 2024-11-19 بهوقت ساعت هماهنگ جهانی."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["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"]]
