Projekt Ensembl
Zadbaj o dobrą organizację dzięki kolekcji
Zapisuj i kategoryzuj treści zgodnie ze swoimi preferencjami.
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.
O ile nie stwierdzono inaczej, treść tej strony jest objęta licencją Creative Commons – uznanie autorstwa 4.0. Szczegółowe informacje na ten temat zawierają zasady dotyczące witryny Google Developers. Java jest zastrzeżonym znakiem towarowym firmy Oracle i jej podmiotów stowarzyszonych.
Ostatnia aktualizacja: 2024-11-08 UTC.
[[["Łatwo zrozumieć","easyToUnderstand","thumb-up"],["Rozwiązało to mój problem","solvedMyProblem","thumb-up"],["Inne","otherUp","thumb-up"]],[["Brak potrzebnych mi informacji","missingTheInformationINeed","thumb-down"],["Zbyt skomplikowane / zbyt wiele czynności do wykonania","tooComplicatedTooManySteps","thumb-down"],["Nieaktualne treści","outOfDate","thumb-down"],["Problem z tłumaczeniem","translationIssue","thumb-down"],["Problem z przykładami/kodem","samplesCodeIssue","thumb-down"],["Inne","otherDown","thumb-down"]],["Ostatnia aktualizacja: 2024-11-08 UTC."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
