이 페이지에는 Google Season of Docs에서 승인된 테크니컬 라이팅 프로젝트의 세부정보가 포함되어 있습니다.
프로젝트 요약
- 오픈소스 조직:
- 앙상블
- 테크니컬 라이터:
- 로렐름
- 프로젝트 이름:
- 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 메서드를 사용하여 URL을 구성하는 방법 소개
자동 생성된 엔드포인트 문서의 필수 및 선택 매개변수와 위치 정보
다음 교육 페이지 링크: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
교육 과정에서 사용되는 도우미_함수에 대한 정보
후속 페이지
기본 페이지에 나열된 주제의 복잡성에 따라 일부 주제를 다음 세부정보 페이지로 연결해야 할 수 있습니다.