Projet OpenMRS.org
Restez organisé à l'aide des collections
Enregistrez et classez les contenus selon vos préférences.
Cette page contient les détails d'un projet de rédaction technique accepté pour la Google Season of Docs.
Résumé du projet
- Organisation Open Source:
- OpenMRS.org
- Rédacteur technique:
- Ayeshmantha
- Nom du projet:
- Développer une documentation GitHub conviviale pour une API REST
- Durée du projet:
- Durée standard (trois mois)
Project description
L'objectif principal du projet est de développer une documentation interactive permettant aux utilisateurs finaux d'interagir avec les API avec des options d'essai, tout en disposant d'une description plus descriptive et auto-explicative qui explique aux personnes techniques et non techniques dans quelle situation utiliser le point de terminaison.
L'environnement swagger actuel est excellent, mais il est difficile d'obtenir une idée directement sans documentation appropriée, que vous soyez ou non un expert technique. L'idée principale est de regrouper cet environnement et cette documentation swagger en un seul endroit avec une belle représentation. À l'aide de JS, HTML et CSS.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/07/25 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Il n'y a pas l'information dont j'ai besoin","missingTheInformationINeed","thumb-down"],["Trop compliqué/Trop d'étapes","tooComplicatedTooManySteps","thumb-down"],["Obsolète","outOfDate","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Mauvais exemple/Erreur de code","samplesCodeIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 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"]]
