本頁針對 Google 系列文件接受的技術撰寫專案提供詳細資料。
專案摘要
- 開放原始碼機構：
- Ensembl
- 技術文件撰寫者：
- laurelm
- 專案名稱：
- REST API 說明文件
- 專案長度：
- 標準長度 (3 個月)
Project description
加強開發人員指南，瞭解如何使用 Ensembl REST API
主要重點：提供使用者更容易理解的簡介/入門部分。
下列文件頁面的逐行列出建議的實作方式：
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
主頁面：
包括以下版面 (高階檢視模式)：
此 API 的實用術語總覽
REST 簡介
簡短範例
驗證資訊
使用各種 HTTP 方法建立網址結構簡介
在自動產生的端點說明文件中找到必要和選用參數的相關資訊，以及這些參數的位置。
連結至以下訓練頁面：https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
訓練課程中使用的 helper_functions 相關資訊
後續網頁
視主頁面列出的主題複雜度而定，某些主題可能需要連結至後續的詳細資料頁面。