Improved REST API Documentation Project

Abstract

Most developers these days prefer to be writing against a RESTful API. Just like GitHub, Amazon, and many others, OpenMRS has a powerful RESTful API; however, an API is only as useful as its documentation. During GSoC 2015, the REST Documentation Generator project used Swagger to generate REST API documentation within the REST web services module. You can see this documentation at demo.openmrs.org by logging in as admin (password is Admin123) and navigating to System Administration > Advanced Administration > REST Web Services > API Documentation.

While the Swagger-based documentation has been helpful, there are several opportunities to improve the documentation. The goal of this project is to improve the living documentation of the OpenMRS REST API through improvements in how Swagger is used and how developers can contribute to the documentation.

Project Champions

• Burke Mamlin

Objectives

• Improve documentation
  • RESTWS-560 - Getting issue details... STATUS
• Optimization
  • RESTWS-568 - Getting issue details... STATUS
• Support for data types
  • RESTWS-562 - Getting issue details... STATUS
• Add search functionality
  • RESTWS-561 - Getting issue details... STATUS
• Bug fixes
  • RESTWS-600 - Getting issue details... STATUS
  • RESTWS-382 - Getting issue details... STATUS

Extra Credit

• TBD

Resources

• swagger.io
• REST Documentation Generator Project