Questa pagina contiene i dettagli di un progetto di scrittura tecnica accettato per la stagione dei documenti Google.
Riepilogo del progetto
- Organizzazione open source:
- Ensembl
- Technical writer:
- laurel
- Nome progetto:
- Documentazione relativa all'API REST
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Migliora la guida dell'utente per gli sviluppatori sull'utilizzo dell'API REST Ensembl
Obiettivo principale - Fornire una sezione introduttiva/per iniziare più facile da usare.
L'implementazione proposta si basa sulle seguenti pagine del documento:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Pagina principale:
Include queste sezioni (visualizzazione di alto livello):
Panoramica dei vantaggi pratici di questa API
Breve introduzione a REST
Un rapido esempio
Informazioni di autenticazione
Introduzione alla struttura degli URL utilizzando vari metodi HTTP
Informazioni sui parametri obbligatori e facoltativi e su dove si trovano nella documentazione dell'endpoint generato automaticamente.
Link alla seguente pagina di formazione: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informazioni sulle funzioni helper_functions utilizzate nel corso di formazione
Pagine successive
A seconda della complessità degli argomenti elencati nella pagina principale, potrebbe essere necessario collegare alcuni argomenti a pagine dei dettagli successive.