Build static API docs from the OpenMRS Swagger JSON
The repository contains the necessary config, templates, scripts and styles to generate a single page containing the static API docs for OpenMRS.
📌 If you are looking for the source to build the API docs that run inside the REST Web Service module, see the swagger-ui branch.
The docs are build using bootprint-openapi. Install this as follows:
npm install -g bootprint
npm install -g bootprint-openapi
Ensure you have you have version 2.14+ or the Rest Web Services module installed
into your OpenMRS instance.
To build the docs run:
bootprint openapi -f config.js http://localhost:8080/openmrs/module/webservices/rest/swagger.json test
Replace the OpenMRS URL with your server.
This will create a directory called test containing the docs.