Bu sayfada, Google Dokümanlar Sezonu için kabul edilen bir teknik yazım projesinin ayrıntıları yer almaktadır.
Proje özeti
- Açık kaynak kuruluşu:
- Ensembl
- Teknik yazar:
- laurelm
- Proje adı:
- REST API belgeleri
- Proje uzunluğu:
- Standart uzunluk (3 ay)
Proje açıklaması
Ensembl REST API'yi kullanmayla ilgili geliştirici kullanıcı kılavuzunu geliştirme
Ana odak: Daha kullanıcı dostu bir giriş/başlangıç bölümü sağlayın.
Önerilen uygulama, aşağıdaki doküman sayfaları doğrultusunda gerçekleştirilir:
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 pratikte sunduğu özelliklere genel bakış
REST'e kısa giriş
Hızlı bir örnek
Kimlik doğrulama bilgileri
URL'lerin çeşitli HTTP yöntemleri kullanılarak nasıl yapılandırıldığına dair giriş
Zorunlu ve isteğe bağlı parametreler ile bunların otomatik olarak oluşturulan uç nokta dokümanlarında nerede bulunduğu 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 bilgi
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.