Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season of Docs.
Ringkasan project
- Organisasi open source:
- Ensembl
- Penulis teknis:
- laurelm
- Nama project:
- Dokumentasi REST API
- Durasi project:
- Durasi standar (3 bulan)
Project description
Meningkatkan panduan pengguna developer untuk menggunakan Ensembl REST API
Fokus utama -- Berikan bagian pengantar/mulai yang lebih mudah digunakan.
Implementasi yang diusulkan didasarkan pada halaman-halaman dokumen ini:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Halaman utama:
Mencakup bagian berikut (tampilan tingkat tinggi):
Ringkasan tentang apa yang disediakan API ini dalam istilah praktis
Pengantar singkat REST
Contoh singkat
Info autentikasi
Pengantar tentang cara URL disusun menggunakan berbagai metode HTTP
Info tentang parameter wajib dan opsional serta tempatnya ditemukan dalam dokumentasi endpoint yang dibuat secara otomatis.
Link ke halaman pelatihan berikut: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Info tentang helper_functions yang digunakan dalam kursus pelatihan
Halaman berikutnya
Bergantung pada kompleksitas topik yang tercantum di halaman utama, beberapa topik mungkin perlu ditautkan ke halaman detail berikutnya.