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.