REST On-premise Installation and Setup Guide

 Table of Contents

1. Introduction

This guide is designed for users of the XML Data Compare REST API. It provides help for the installation and initial setup of the HTTP server and wrapper component that provides the XML Data Compare REST API. The XML Data Compare REST service allows you to invoke XML comparisons from a wide range of programming languages and systems.

2. Installation

This release contains a JAR with a suffix indicating the major.minor.patch version:

  • deltaxml-data-compare-1.0.0.jar

A license file is required to enable the REST service. The file should be called deltaxml-data-compare-rest.lic and should contain a license feature for 'xml_data_compare_rest'. The file should also be placed into the XML Data Compare install directory together with existing jar files.

3. Starting and Stopping the Service

To start the REST service use the following command (adjust heap and stack sizes as needed or to suit the target system) from the install directory. If all is well some lines of debug and information messages will appear as indicated below.

Note

Replace x.y.z with the major.minor.patch version number of your release e.g. deltaxml-data-compare-1.0.0.jar

$ java -Xmx4g -Xss20m -jar deltaxml-data-compare-x.y.z.jar 
XML Data Compare REST service started, navigate to: http://0.0.0.0:8080/api/xml-data-compare/v1/compare
Press Control-C to stop it...

When using JDK 9.0 or later an additional add-modules argument is required:

$ java -version
java version "9.0.4"
Java(TM) SE Runtime Environment (build 9.0.4+11)
Java HotSpot(TM) 64-Bit Server VM (build 9.0.4+11, mixed mode)
$ java --add-modules java.xml.bind -jar deltaxml-rest-x.y.z.jar

To stop the service use Control-C as indicated or an appropriate operating system command/tool such as 'kill'.

4. Using the Service

4.1. Command-Line Tool

See here for how to use the XML Data Compare command line tool.

4.2. Postman

The Postman API development and testing app provides a simple way to test the XML Data Compare REST API. We provide a Postman Collection to help get you started with the REST API, details on this are included in the Testing using Postman section of the REST User Guide.

#content .code