Ensembl 專案

本頁面包含 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 相關資訊

後續頁面

視主頁中列出的主題複雜度而定，部分主題可能需要連結至後續的詳細資料頁面。