Projet Ensembl

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.