このページには、Google シーズンのドキュメントで受け入れられているテクニカル ライティング プロジェクトの詳細が記載されています。
プロジェクトの概要
- オープンソースの組織:
- アンサンブル
- テクニカル ライター:
- 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 に関する情報
後続のページ
メインページに表示されているトピックの複雑さによっては、一部のトピックを後続の詳細ページにリンクする必要があります。