このページでは、Google Season of Docs に承認された技術文書作成プロジェクトの詳細について説明します。
プロジェクトの概要
- オープンソース組織:
- 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 の簡単な概要
簡単な例
認証情報
さまざまな HTTP メソッドを使用して URL がどのように構成されているかについて
必須パラメータと省略可能なパラメータに関する情報、および自動生成されたエンドポイントのドキュメント内の場所。
次のトレーニング ページへのリンク: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
トレーニング コースで使用される helper_functions に関する情報
以降のページ
メインページに表示されるトピックの複雑さに応じて、一部のトピックは後続の詳細ページにリンクする必要があります。