Wiki Spaces
Documentation
Projects
Resources
Get Help from Others
Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack
Primary Mentor | |
Backup Mentor | |
Assigned to | TBD |
Extend the existing User-Friendly GitHub Documentation for Rest API project.
The OpenMRS REST API is one of the key mechanisms for developers to access data from OpenMRS. We have used Swagger to create auto-generated documentation of the API.
See a sample of the auto-generated REST API documentation here.
In the last year with GSoD, we developed a user-friendly GitHub documentation. Which can be found hosted in this URL
The purpose of this project is to come up with documentation for the missing resources and add more examples (Currently we have only curl example add Javascript, Java examples).
The final goal is to make the documentation a playground for the newcomers to get an idea about the current resources we have in openMRS.
You can find the repository for the project here (As you can see the build is failing to fix it would be a good starting point to get an idea how things work with the static content server used underneath).