jsonata-server

JSONata Server

A server-side processor for JSONata that supports JSON, XML and CSV input/output, with a feature-rich UI editor powered by Monaco Editor

Features

• Unlimited Processing Time: Server-side processing removes browser limitations.
• Flexible Input/Output: Supports both JSON, XML and CSV formats.
• Choose your CSV Delimiter: comma, semi-column and tab are supported
• File Generation: No need to copy-paste into files, you can download the result as a file
• Data Persistence: Saves data to local storage to prevent data loss.
• Dark/Light Mode: Choose your preferred theme.
• Auto-refresh: Automatically updates the data.
• Error Highlighting: Find easily in your JSONata expression what went wrong
• Autocompletion and documentation: JSONata documentation for functions is embbed
• Advanced UI Editor: Powered by Monaco Editor.
• JS Bindings and Mustache templating: Go beyond Jsonata capabilities

Screenshot

Custom Bindings

You can use JSONata bindings feature directly inside the JSONata expression window. To do so, add //BINDINGS at the end of your JSONata expression, followed by your custom bindings. Example:

"hello there!" ~> $firstLetterUppercase
//BINDINGS
{
   firstLetterUppercase(input) {
      return input.charAt(0).toUpperCase() + input.slice(1);
   }
}

will produce the following result

"Hello there!"

Mustache templating

Simply call $mustache to perform render a template

{"firstName": "John", "lastName": "Doe"} ~> $mustache("
Hello {{firstName}} {{lastName}} !!
")

will produce the following result (Raw output mode):

Hello John Doe !!

Getting Started

With NPM

[!NOTE] NodeJS >=18.3 must be installed on your machine

• Install NPM CLI package globally:

  npm install -g jsonata-server
  

• Start the server:

  PORT=3000 jsonata-server
  

With Docker

[!NOTE] You must be authenticated on the Github Container Registery

docker run -d -p 3000:3000 ghcr.io/joussy/jsonata-server

Accessing the Client

Open your browser and navigate to http://localhost:3000

Build from sources

Installation

• Clone the repository:

  git clone https://github.com/joussy/jsonata-server.git
  

• Navigate to the project directory:

  cd jsonata-server
  

• Install the dependencies

  npm install
  

Building the Docker Image

• Build the Docker image:

docker build -t jsonata-server .

Running the Docker Container

• Run the Docker container:

docker run -d -p 3000:3000 --name jsonata-server jsonata-server

• Open your browser and navigate to http://localhost:3000

Dependencies

Node.js Server

• JSONata
• CSV
• Express
• xml-js

HTML Client

• Vue.js
• Bootstrap
• Monaco Editor
• Splitpanes

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

License

This project is licensed under the MIT License - see the LICENSE file for details.