Halaman ini berisi detail project penulisan teknis yang diterima untuk Google Season Dokumen.
Ringkasan proyek
- Organisasi open source:
- Ensembl
- Penulis teknis:
- laurelm
- Nama proyek:
- Dokumentasi REST API
- Durasi proyek:
- Durasi standar (3 bulan)
Project description
Tingkatkan kualitas panduan pengguna developer untuk menggunakan Ensembl REST API
Fokus utama -- Memberikan bagian pengantar/memulai yang lebih mudah digunakan.
Implementasi yang diusulkan didasarkan pada alur dari halaman dokumen berikut:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Halaman utama:
Mencakup bagian ini (tampilan tingkat tinggi):
Ringkasan tentang hal yang disediakan API ini secara praktis
Pengantar singkat tentang REST
Contoh singkat
Info autentikasi
Pengantar cara URL disusun menggunakan berbagai metode HTTP
Info tentang parameter wajib dan opsional serta lokasinya di 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 selanjutnya.