npm package: @rmlio/rmlmapper-webapi
Description: Web API for the RMLMapper
Author: Pieter Heyvaert
Latest version: 2.3.7

<!-- omit in toc -->
# Web API for the RMLMapper

![code coverage](https://img.shields.io/badge/coverage-100%25-success.svg)

<!-- omit in toc -->
## Table of contents

- [Requirements](#requirements)
- [Usage](#usage)
  - [Library](#library)
  - [CLI](#cli)
  - [Docker](#docker)
- [Configuration object/file](#configuration-objectfile)
- [How to make API calls](#how-to-make-api-calls)
- [Development](#development)
  - [Set-up](#set-up)
  - [Run tests](#run-tests)
  - [Use](#use)
- [License](#license)

## Requirements
- Node.js
- Java VM

## Usage

The package can be used as a library, CLI, and via Docker.

### Library

#### Set-up

- Install dependencies: `npm install`.
- The RMLMapper needs to be available in the root and called `rmlmapper.jar`.
  Download it via `node bin/download-rmlmapper-cli.js [version]`.
  - `version` is optional to get a specific version, e.g. `5.0.0` (default: latest)

#### Usage

The package can be used as a library as follows:

```JavaScript
const Api = require('@rmlio/rmlmapper-webapi');
const config = {}; // see below

// Create API.
const api = new Api(config);
api.set('port', config.port);

// Create and launch server.
const server = http.createServer(api);
server.listen(config.port);
```

The config object looks as follows:

 - `rmlmapper.path`: path to the RMLMapper jar (required).
 - `rmlmapper.version`: version of the used RMLMapper. This is shown on the main page of the API (required).
 - `baseURL`: url of where the API will be available. This is shown on the main page of the API (default: http://localhost + port).
 - `removeTempFolders`: if this is set true, temporary folders are removed once the execution of one call is done (default: true).
 - `logLevel`: log level used by the logger (default: info).
 - `port`: port of the server (default: 4000).
 - `basePath`: the path preceding all routes (default: /).

### CLI

- Install the server: `npm i -g @rmlio/rmlmapper-webapi`.
- Start the server: `rmlmapper-webapi`.
- The server is available at `http://localhost:4000` (if port is unchanged).

The following paramaters can be used to configure the server:

```
Usage: cli [options]

Options:
  -V, --version                    output the version number
  -p, --port [port]                Port of the server (default: 4000).
  -e, --baseURL [url]              Url of the server (default: http://localhost:4000).
  -r, --rmlmapper [path]           Path to the RMLMapper jar (default: rmlmapper.jar).
  --rmlmapper-version [version]    Version of the used RMLMapper.
  -t, --removeTempFolders          True if temp folders should be removed, else false (default: true).
  -b, --basePath [path]            The path preceding all routes (default: /).
  -l, --logLevel [level]           The log level used by the logger (default: info).
  -o, --behind-reverse-proxy       Enable if the server is behind a reverse proxy (e.g., NGINX).
  --rate-limiter-window [minutes]  The window of the rate limiter (default: infinity).
  --rate-limiter-max [integer]     The max requests allowed by the rate limiter (default: infinity).
  -h, --help                       display help for command
```

Parameters can also be set via a configuration file called `config.json`, 
which is located in the current working directory,
and contains same options as the [config object](#library) when using the package as library.
An example can be found in `config_example.json`.
The latest version of the RMLMapper is downloaded when running the server if no `rmlmapper.path` is given.
The version is automatically determined.

### Docker

- Build image: `docker build -t rmlmapper-webapi .`
- Run container: `docker container run -p 4000:4000 rmlmapper-webapi`

## Configuration object/file

Parameters can also be set via a configuration file called `config.json`, 
which is located in the current working directory,
and contains the following settings:

- `rmlmapper.path`: path to the RMLMapper jar.
- `rmlmapper.version`: version of the used RMLMapper. This is shown on the main page of the API.
- `baseURL`: url of where the API will be available. This is shown on the main page of the API.
- `removeTempFolders`: if this is set true, temporary folders are removed once the execution of one call is done.
- `logLevel`: log level used by the logger (default: info).
- `port`: port of the server (default: 4000).
- `basePath`: the path preceding all routes (default: /).

An example can be found in `config_example.json`.
The latest version of the RMLMapper is downloaded when running the server if no `rmlmapper.path` is given.
The version is automatically determined.

## How to make API calls

When the server is running you can find the descriptions of the calls at the root of the server (e.g., `http://localhost:4000`).
The calls are also described using the [Open API specification](https://github.com/OAI/OpenAPI-Specification) in `/swagger.yaml`.

## Development

### Set-up

- Install dependencies: `npm install`.
- The RMLMapper needs to be available in the root and called `rmlmapper.jar`.
  Download via `npm run download:rmlmapper [version]`.
    - `version` is optional to get a specific version, e.g. `5.0.0` (default: latest)

### Run tests

- Run the tests: `npm test`.
The test framework is [Mocha](https://mochajs.org/) and the code coverage is provided via [Istanbul](https://istanbul.js.org/).

### Use

- `npm start`

## License

This code is copyrighted by [Ghent University – imec](http://idlab.ugent.be/) and 
released under the [MIT license](http://opensource.org/licenses/MIT).