Cette page contient les détails d'un projet de rédaction technique accepté pour Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- Ensembl
- Rédacteur technique:
- laurelm
- Nom du projet:
- Documentation de l'API REST
- Durée du projet:
- Durée standard (3 mois)
Project description
Amélioration du guide de l'utilisateur du développeur concernant l'utilisation de l'API REST Ensembl
Objectif principal : proposer une introduction/section de démarrage plus conviviale.
L'implémentation proposée est basée sur les lignes des pages suivantes:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Page principale:
Comprend les sections suivantes (vue de haut niveau):
Présentation pratique de ce que cette API fournit
Courte présentation de REST
Un bref exemple
Informations d'authentification
Présentation de la structure des URL à l'aide de différentes méthodes HTTP
Des informations sur les paramètres obligatoires et facultatifs, et où ils se trouvent dans la documentation sur les points de terminaison générés automatiquement.
Lien vers la page de formation suivante : https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Des informations sur les fonctions helper_functions utilisées dans la formation
Pages suivantes
En fonction de la complexité des sujets répertoriés sur la page principale, certains sujets devront être associés à d'autres pages d'informations.