Progetto Ensembl
Mantieni tutto organizzato con le raccolte
Salva e classifica i contenuti in base alle tue preferenze.
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.
Salvo quanto diversamente specificato, i contenuti di questa pagina sono concessi in base alla licenza Creative Commons Attribution 4.0. Per ulteriori dettagli, consulta le norme del sito di Google Developers. Java è un marchio registrato di Oracle e/o delle sue consociate.
Ultimo aggiornamento 2024-11-08 UTC.
[[["Facile da capire","easyToUnderstand","thumb-up"],["Il problema è stato risolto","solvedMyProblem","thumb-up"],["Altra","otherUp","thumb-up"]],[["Mancano le informazioni di cui ho bisogno","missingTheInformationINeed","thumb-down"],["Troppo complicato/troppi passaggi","tooComplicatedTooManySteps","thumb-down"],["Obsoleti","outOfDate","thumb-down"],["Problema di traduzione","translationIssue","thumb-down"],["Problema relativo a esempi/codice","samplesCodeIssue","thumb-down"],["Altra","otherDown","thumb-down"]],["Ultimo aggiornamento 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"]]
