An open API service indexing awesome lists of open source software.

https://github.com/sanjuthomas/marklogic-dls-rest-extension

MarkLogic Document Library Services (DLS) REST Extension
https://github.com/sanjuthomas/marklogic-dls-rest-extension

dls-functions javascript marklogic rest rest-api rest-extension

Last synced: 11 months ago
JSON representation

MarkLogic Document Library Services (DLS) REST Extension

Awesome Lists containing this project

README

          

# What is MarkLogic Document Library Service?

The Library Services enable you to create and maintain versions of managed documents in MarkLogic Server. Access to managed documents is controlled using a check-out/check-in model. For more details refer to MarkLogic official documentation [here](https://docs.marklogic.com/guide/app-dev/dls).

# What is MarkLogic DLS REST Extension?

You are here because you already know that, as of today, the DLS XQuery APIs are not exposed via REST in MarkLogic. You may use this project as a reference implementation to expose the DLS XQuery functions via REST.

## Installation and Testing

git clone https://github.com/sanjuthomas/marklogic-dls-rest-extension.git

cd marklogic-dls-rest-extension

gradle mlDeploy

Sample Requests for both read and update functions are available [here](https://github.com/sanjuthomas/marklogic-dls-rest-extension/tree/master/src/sample-requests). You may use a standard REST client like Postman to test.

## What is not yet implemented?
You can find all the DLS functions exposed via the REST extension [here](https://github.com/sanjuthomas/marklogic-dls-rest-extension/blob/master/src/main/ml-modules/lib/dls-function-conf.sjs). In the current version, the optional parameter to the DLS functions are not read from the request.

## Contact
Please contact me at ml@sanju.org if you find any issues or looking for clarification.