OpenMRS REST Web Services Module
REST API for OpenMRS
The module exposes the OpenMRS API as REST web services. If an OpenMRS instance is running the webservice.rest module, other applications can retrieve and post certain information to an OpenMRS database.
Download
If you are not a developer, or just want to install the REST Web Services module into your system, visit the module download page instead.
The required OpenMRS version to run the REST Web Services Module is
1.8.4+or1.9.0+
Build
To build the module from source, clone this repo:
git clone https://github.com/openmrs/openmrs-module-webservices.rest
Then navigate into the openmrs-module-webservices.rest directory and compile the module using Maven:
cd openmrs-module-webservices.rest && mvn clean install
Developer Documentation
Integration Tests
Integration tests can be found in the integration-tests directory. They are written with JUnit and Rest-Assured. Before you can run integration tests you need to start up a server and install the module. You can run integration tests with:
mvn clean verify -Pintegration-tests -DtestUrl=http://admin:Admin123@localhost:8080/openmrs
You can skip the testUrl parameter, if it is the same for your server.
Wiki Pages
| Page | Description |
|---|---|
| REST Module | The main module page with a description of the configuration options. |
| Technical Documentation | Technical information about the Web Services implementation. |
| Core Developer Guide | Description of how to add REST resources to OpenMRS core. |
| Module Developer Guide | Description of how to add REST resources to OpenMRS modules. |
API Documentation
The API documentation is available inside the OpenMRS application and is linked to the advanced administration screen. The URL should be something like:
http://localhost:8080/openmrs/module/webservices/rest/apiDocs.htm
Example Client code
- Quick java swing client that displays patients and encounters: http://svn.openmrs.org/openmrs-contrib/examples/webservices/hackyswingexample/
- You can download a client java application that allows add/edit a person (any resource) by making a query to the webservices.rest module - https://project-development-software-victor-aravena.googlecode.com/svn/trunk/ClientOpenMRSRest/
Contributing to the API Documentation
The OpenMRS API documentation is built automatically using Swagger UI. For details on how to customize the documentation see the swagger-ui branch in the openmrs-contrib-apidocs repo.