Projeto OpenMRS.org
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 redação técnica aceito para a
Google Season of Docs.
Resumo do projeto
- Organização de código aberto:
- OpenMRS.org
- Redator técnico:
- Ayeshmantha
- Nome do projeto:
- Como desenvolver uma documentação do GitHub fácil de usar para a API REST
- Duração do projeto:
- Duração padrão (três meses)
Project description
O objetivo principal do projeto é desenvolver uma documentação interativa em que os usuários finais possam interagir com as APIs com opções de teste e, ao mesmo tempo, ter uma descrição mais descritiva e autoexplicativa que explique para pessoas técnicas e não técnicas em quais situações é preciso usar o endpoint.
O ambiente atual é ótimo, mas ainda assim é mais difícil ter uma ideia sem a documentação adequada para quem não é técnico. A ideia principal é ter esse ambiente e a documentação do Swagger em um só lugar com uma boa representação. Com a ajuda de JS, HTML e CSS.
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 2025-07-25 UTC.
[null,null,["Última atualização 2025-07-25 UTC."],[],["The project aims to improve the OpenMRS.org REST API documentation by creating an interactive environment where users can test APIs. The core objective is to make the documentation more accessible to both technical and non-technical users. This will involve integrating the existing Swagger environment with descriptive documentation, including \"try out\" options. The project will use JS, HTML, and CSS to create a user-friendly interface and enhance the presentation of the API documentation. The project will last three months.\n"],null,[]]
