Projeto Ensembl
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
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.
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2024-11-08 UTC.
[[["Fácil de entender","easyToUnderstand","thumb-up"],["Meu problema foi resolvido","solvedMyProblem","thumb-up"],["Outro","otherUp","thumb-up"]],[["Não contém as informações de que eu preciso","missingTheInformationINeed","thumb-down"],["Muito complicado / etapas demais","tooComplicatedTooManySteps","thumb-down"],["Desatualizado","outOfDate","thumb-down"],["Problema na tradução","translationIssue","thumb-down"],["Problema com as amostras / o código","samplesCodeIssue","thumb-down"],["Outro","otherDown","thumb-down"]],["Última atualização 2024-11-08 UTC."],[[["This project focuses on improving the Ensembl REST API documentation, specifically the introductory and getting started sections, to make it more user-friendly for developers."],["The documentation will include an overview of the API's functionality, a brief introduction to REST, a practical example, authentication details, URL structure explanation, and information about parameters and the Ensembl training course."],["Certain complex topics may have dedicated detailed pages linked from the main documentation page for comprehensive understanding."],["This is a Google Season of Docs project, with Ensembl as the open-source organization and laurelm as the technical writer, lasting for three months."]]],["The core of this project is to improve the Ensembl REST API developer user guide. Key actions include creating a user-friendly introduction, covering REST API basics, authentication, URL structure, and parameter usage. The main page will provide an overview, a quick example, and links to training and helper functions. Depending on the complexity, subsequent pages with detailed explanations may be necessary. The project will use Google's documentation as a model.\n"]]
