پروژه آنسامبل

این صفحه حاوی جزئیات یک پروژه نگارش فنی است که برای فصل اسناد 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 که در دوره آموزشی استفاده می شود


صفحات بعدی

بسته به پیچیدگی موضوعات فهرست شده در صفحه اصلی، برخی از موضوعات ممکن است نیاز به پیوند به صفحات جزئیات بعدی داشته باشند.