RESTHeart

The leading REST API Server for MongoDB.

RESTHeart connects to MongoDB and opens data to the Web: Mobile and JavaScript applications can use the database via RESTful HTTP API calls.

For an example, check our AngularJs Notes Example Application.

Built on strong foundations

The API strictly follows the RESTful paradigm.
Resources are represented with the HAL+json format.
Built on top of Undertow web server.
Makes use of few, best of breed libraries, check the pom.xml!

Rapid Development

No server side development is required in most of the cases for your web and mobile applications.
The Setup is simple with convention over configuration approach; Docker Container and Vagrant Box are available.
Access Control and Schema Check are provided out of the box.

Production ready

High quality Documentation and active development community.
Severe Unit and Integration test suite, Code Check and Continuous Integration process.
Commercial Support available from SoftInstigate, the company behind RESTHeart.

Fast & Light

High throughput check the performance tests.
Lightweight ~7Mb footprint, low RAM usage, starts in ~1 sec.
Horizontally Scalable with Stateless Architecture and full support for MongoDB replica sets and shards.
µService: it does one think and it does it well.

Documentation

Web site: http://restheart.org
Issues: https://softinstigate.atlassian.net/projects/RH
Documentation: https://softinstigate.atlassian.net/wiki/display/RH/Documentation

An Example

RESTHeart enables clients to access MongoDB via a HTTP RESTful API

In the following example, a web client sends an HTTP GET request to the /blog/posts URI and gets back the list of blog posts documents.

For more examples, check the API tutorial

Installation

RESTHeart can be installed on any OS supporting Java.

Complete instruction at Installation and Setup documentation section.

Docker container and Vagrant box are also available.

How to run it

Running RESTHeart requires Java 8

Download the latest release from github releases page, unpack the archive and just run the jar.

$ java -server -jar restheart.jar

You might also want to specify a configuration file:

$ java -server -jar restheart.jar etc/restheart.yml

the restheart.yml configuration enables authentication: users, roles and permission are defined in etc/security.yml

Configuration file documentation
Example configuration file restheart.yml
Security documentation

How to build it

Building RESTHeart requires Maven.

Clone the repository and update the git submodules (the HAL browser is included in restheart as a submodule):

$ git submodule update --init --recursive

Build the project with Maven:

$ mvn clean package

Integration tests

Optionally you can run the integration test suite. Make sure mongod is running on localhost on default port 27017 without authentication enabled, i.e. no --auth option is specified.

$ mvn verify -DskipITs=false

Made with ❤️ by The SoftInstigate Team. Follow us on Twitter.

FaionWeb/restheart