Ta strona zawiera szczegóły projektu technicznego do pisania w sezonie Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Ensembl
- Pisarz techniczny:
- laurel
- Nazwa projektu:
- Dokumentacja interfejsu API typu REST
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ulepszenie przewodnika dla deweloperów dotyczącego korzystania z interfejsu API REST Ensembl
Główny nacisk – umieść w sekcji wprowadzającej/początkowej bardziej przyjazne użytkownikowi treści.
Proponowana implementacja opiera się na poniższych stronach dokumentu:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Strona główna:
Zawiera te sekcje (widok ogólny):
Omówienie funkcji w praktyce zapewnianym przez ten interfejs API
Krótkie wprowadzenie do REST
Szybki przykład
Dane uwierzytelniające
Wprowadzenie do tworzenia struktury adresów URL za pomocą różnych metod HTTP
Informacje o wymaganych i opcjonalnych parametrach oraz o miejscu ich występowania w automatycznie generowanej dokumentacji punktu końcowego.
Link do tej strony szkolenia: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informacje o funkcjach pomocniczych helper_functions używanych w programie szkoleniowym
Kolejne strony
W zależności od złożoności tematów wymienionych na stronie głównej niektóre z nich mogą wymagać linków do kolejnych stron szczegółowych.