Google uses AI technology to translate content into your preferred language. AI translations can contain errors.
Projet Ensembl
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Principes de base
- Rédacteur technique:
- laurelm
- Nom du projet:
- Documentation de l'API REST
- Durée du projet:
- Durée standard (trois mois)
Project description
Amélioration du guide de l'utilisateur du développeur pour l'utilisation de l'API REST Ensembl
Axe principal : fournissez une section d'introduction/de démarrage plus conviviale.
L'implémentation proposée est basée sur les pages de documentation suivantes:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Page principale:
Inclut les sections suivantes (vue de haut niveau):
Présentation de ce que cette API propose concrètement
Brève présentation de REST
Un bref exemple
Informations d'authentification
Présentation de la structuration des URL à l'aide de différentes méthodes HTTP
Informations sur les paramètres obligatoires et facultatifs, ainsi que sur leur emplacement dans la documentation du point de terminaison générée automatiquement.
Lien vers la page de formation suivante : https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informations sur les fonctions d'assistance utilisées dans le cours de formation
Pages suivantes
Selon la complexité des sujets listés sur la page principale, certains d'entre eux peuvent être liés à des pages d'informations ultérieures.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/07/25 (UTC)."],[],["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"]]
