Diese Seite enthält die Details zu einem Projekt für technische Angelegenheiten, das für die Google-Saison der Dokumente angenommen wurde.
Projektzusammenfassung
- Open-Source-Organisation:
- Ensembl
- Technischer Redakteur:
- laurelm
- Projektname:
- REST API-Dokumentation
- Projektdauer:
- Standardlänge (3 Monate)
Projektbeschreibung
Die Entwickleranleitung für die Verwendung der Ensembl REST API verbessern
Hauptaugenmerk: Bieten Sie einen nutzerfreundlicheren Abschnitt mit einer Einführung und Informationen zum Einstieg.
Die vorgeschlagene Implementierung basiert auf den folgenden Dokumentseiten:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Hauptseite:
Sie enthält die folgenden Abschnitte (Übersicht):
Übersicht über den praktischen Nutzen dieser API
Kurze Einführung in REST
Kurzes Beispiel
Authentifizierungsinformationen
Einführung in die Strukturierung der URLs mithilfe verschiedener HTTP-Methoden
Informationen zu den erforderlichen und optionalen Parametern und dazu, wo sie in der Dokumentation zu automatisch generierten Endpunkten zu finden sind.
Link zur folgenden Schulungsseite: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informationen zu den Hilfsfunktionen, die im Trainingskurs verwendet werden
Nachfolgende Seiten
Je nach Komplexität der auf der Hauptseite aufgeführten Themen müssen einige Themen möglicherweise mit nachfolgenden Detailseiten verknüpft werden.