Ta strona zawiera szczegółowe informacje na temat projektu technicznego przyjęta do programu Sezon Dokumentów Google.
Podsumowanie projektu
- Organizacja open source:
- Ensembl
- Pisarz techniczny:
- laurelm
- Nazwa projektu:
- Dokumentacja API typu REST
- Długość projektu:
- Standardowa długość (3 miesiące)
Opis projektu
Ulepszenie przewodnika użytkownika dla programistów pod kątem korzystania z interfejsu Ensembl API typu REST
Główny temat – sekcję wprowadzenia i wprowadzenia dla użytkownika powinna być bardziej czytelna dla użytkownika.
Proponowana implementacja opiera się na informacjach podanych na tych stronach dokumentu:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Strona główna:
Obejmuje te sekcje (widok wysokiego poziomu):
Omówienie jego praktycznego wykorzystania
Krótkie wprowadzenie do REST
Krótki przykład
Informacje uwierzytelniające
Wprowadzenie do struktury adresów URL przy użyciu różnych metod HTTP
Informacje o wymaganych i opcjonalnych parametrach oraz o ich lokalizacji znajdziesz w automatycznie wygenerowanej dokumentacji punktu końcowego.
Link do tej strony szkoleniowej: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informacje o funkcjach pomocniczych używanych w kursie
Kolejne strony
W zależności od złożoności tematów wymienionych na stronie głównej niektóre tematy mogą zawierać linki do kolejnych stron z informacjami.