На этой странице содержится подробная информация о проекте технического написания, принятом для участия в Google Season of Docs.
Краткое описание проекта
- Организация с открытым исходным кодом:
- Ансамбль
- Технический писатель:
- лавр
- Название проекта:
- Документация по 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
Быстрый пример
Информация для аутентификации
Введение в структуру URL-адресов с использованием различных методов HTTP.
Информация об обязательных и необязательных параметрах и о том, где они находятся в автоматически создаваемой документации по конечной точке.
Ссылка на следующую страницу обучения: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api .
Информация о helper_functions, которые используются в учебном курсе
Последующие страницы
В зависимости от сложности тем, перечисленных на главной странице, некоторые темы могут нуждаться в ссылках на последующие страницы с подробными сведениями.