Questa pagina contiene i dettagli di un progetto di documentazione tecnica accettato per la stagione della documentazione di Google.
Riepilogo del progetto
- Organizzazione open source:
- Ensembl
- Redattore tecnico:
- laurelm
- Nome del progetto:
- Documentazione dell'API REST
- Durata del progetto:
- Durata standard (3 mesi)
Project description
Migliorare la guida dell'utente per gli sviluppatori per l'utilizzo dell'API REST di Ensembl
Obiettivo principale: fornire una sezione introduttiva/introduttiva più agevole.
L'implementazione proposta si basa sulle seguenti pagine di documentazione:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Pagina principale:
Include le seguenti sezioni (visualizzazione di alto livello):
Panoramica di ciò che questa API offre in termini pratici
Breve introduzione a REST
Un esempio rapido
Informazioni di autenticazione
Introduzione alla struttura degli URL utilizzando vari metodi HTTP
Informazioni sui parametri obbligatori e facoltativi e sulla loro posizione nella documentazione dell'endpoint generata automaticamente.
Link alla seguente pagina di formazione: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informazioni sulle funzioni di assistenza utilizzate nel corso di formazione
Pagine successive
A seconda della complessità degli argomenti elencati nella pagina principale, per alcuni potrebbe essere necessario inserire un link a pagine dei dettagli successive.