Esta página contém os detalhes de um projeto de escrita técnica aceito para o Temporada dos Documentos Google.
Resumo do projeto
- Organização de código aberto:
- Ensembl
- Redator técnico:
- laurelm
- Nome do projeto:
- Documentação da API REST
- Duração do projeto:
- Duração padrão (três meses)
Project description
Melhoria no guia do usuário para desenvolvedores sobre como usar a API REST do Ensembl
Foco principal: fornecer uma seção de introdução/início mais fácil de usar.
A implementação proposta é baseada nas seguintes 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:
Inclui estas seções (visão geral):
Visão geral do que essa API oferece na prática
Introdução breve à REST
Um exemplo rápido
Informações de autenticação
Introdução sobre como os URLs são estruturados usando vários métodos HTTP
Informações sobre os parâmetros obrigatórios e opcionais e onde eles são encontrados na documentação do endpoint gerada automaticamente.
Link para a seguinte página de treinamento: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informações sobre as funções auxiliares usadas no curso de treinamento
Páginas seguintes
Dependendo da complexidade dos temas listados na página principal, alguns deles podem precisar de links para páginas de detalhes subsequentes.