Bu sayfa, Google Dokümanlar Sezonu için kabul edilen bir teknik yazı projesinin ayrıntılarını içerir.
Proje özeti
- Açık kaynak kuruluşu:
- Topluluk
- Teknik yazar:
- laurelm
- Projenin adı:
- REST API belgeleri
- Proje süresi:
- Standart uzunluk (3 ay)
Proje açıklaması
Ensembl REST API kullanımıyla ilgili geliştirici kullanıcı rehberini iyileştirme
Ana odak noktası -- Daha kullanıcı dostu bir giriş/başlangıç bölümü sağlayın.
Önerilen uygulama, aşağıdaki doküman sayfalarında bulunan bilgilere dayanır:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Ana sayfa:
Şu bölümleri içerir (üst düzey görünüm):
Bu API'nin pratik açısından sağladıklarına genel bakış
REST'e kısa giriş
Kısa bir örnek
Kimlik doğrulama bilgileri
URL'lerin çeşitli HTTP yöntemleri kullanılarak nasıl yapılandırıldığına giriş
Zorunlu ve isteğe bağlı parametreler ile otomatik olarak oluşturulan uç nokta belgelerinde bu parametrelerin bulunduğu yerler hakkında bilgi.
Aşağıdaki eğitim sayfasının bağlantısı: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Eğitim kursunda kullanılan Helper_functions hakkında bilgiler
Sonraki sayfalar
Ana sayfada listelenen konuların karmaşıklığına bağlı olarak, bazı konuların sonraki ayrıntı sayfalarına bağlantı vermesi gerekebilir.