Esta página contiene los detalles de un proyecto de redacción técnica aceptado para la GDOC Season of Docs.
Resumen del proyecto
- Organización de código abierto:
- Conjunto
- Redactor técnico:
- laurelm
- Nombre del proyecto:
- Documentación de la API de REST
- Duración del proyecto:
- Duración estándar (3 meses)
Project description
Mejora la guía de usuario para desarrolladores para usar la API de REST de Ensembl
Enfoque principal: Proporciona una sección de introducción o de primeros pasos más fácil de usar.
La implementación propuesta se basa en las líneas de estas páginas de documentos:
https://developers.google.com/maps/documentation/maps-static/intro
https://developers.google.com/maps/documentation/maps-static/dev-guide
Página principal:
Incluye las siguientes secciones (vista de alto nivel):
Descripción general de lo que proporciona esta API en términos prácticos
Breve introducción a REST
Ejemplo rápido:
Información de autenticación
Introducción a la estructura de las URLs con varios métodos HTTP
Información sobre los parámetros obligatorios y opcionales, y dónde se encuentran en la documentación del extremo generada automáticamente.
Vínculo a la siguiente página de capacitación: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Información sobre las helper_functions que se usan en el curso de capacitación
Páginas posteriores
Según la complejidad de los temas que se enumeran en la página principal, es posible que algunos deban vincularse a páginas de detalles posteriores.