Esta página contém os detalhes de um projeto de escrita técnica aceito para a temporada de documentos do Google.
Resumo do projeto
- Organização de código aberto:
- Conjunto
- Redator técnico:
- laurelm
- Nome do projeto:
- Documentação da API REST
- Duração do projeto:
- Duração padrão (3 meses)
Project description
Aprimoramento do guia do usuário para desenvolvedores para usar a API REST Ensembl
Foco principal: forneça uma introdução/seção de primeiros passos que seja mais fácil de usar.
A implementação proposta é baseada nas linhas destas páginas de documento:
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 (visualização de alto nível):
Visão geral do que essa API oferece em termos práticos
Breve introdução ao REST
Um exemplo rápido
Informações de autenticação
Introdução à estrutura de URLs 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 página de treinamento a seguir: https://www.ebi.ac.uk/training/online/course/ensembl-rest-api
Informações sobre as help_functions usadas no curso de treinamento
Páginas subsequentes
Dependendo da complexidade dos tópicos listados na página principal, alguns tópicos podem precisar de links para páginas de detalhes subsequentes.