หน้านี้มีรายละเอียดโครงการงานเขียนเชิงเทคนิคที่ได้รับการยอมรับใน Google Season of เอกสาร
สรุปโปรเจ็กต์
- องค์กรโอเพนซอร์ส
- Ensembl
- นักเขียนเชิงเทคนิค
- laurelm
- ชื่อโปรเจ็กต์:
- เอกสารประกอบเกี่ยวกับ 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 ที่ใช้ในหลักสูตรการฝึกอบรม
หน้าต่อๆ ไป
หัวข้อบางหัวข้ออาจต้องลิงก์ไปยังหน้ารายละเอียดต่อๆ ไป ทั้งนี้ขึ้นอยู่กับความซับซ้อนของหัวข้อที่แสดงในหน้าหลัก