โปรเจ็กต์ Ensembl

หน้านี้มีรายละเอียดของโครงการการเขียนเชิงเทคนิคที่ยอมรับสำหรับ Google Season of Docs

ข้อมูลสรุปของโปรเจ็กต์

องค์กรโอเพนซอร์ส:
ฉบับปก
ผู้เขียนด้านเทคนิค:
ลอเรล์ม
ชื่อโปรเจ็กต์:
เอกสารประกอบของ 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 ที่ใช้ในหลักสูตรการฝึกอบรม


หน้าต่อๆ ไป

บางหัวข้ออาจต้องลิงก์ไปยังหน้ารายละเอียดต่อๆ ไป ทั้งนี้ขึ้นอยู่กับความซับซ้อนของหัวข้อที่แสดงในหน้าหลัก