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 的信息

后续页面

根据主页面中列出的主题的复杂程度，某些主题可能需要链接到后续的详情页面。