The Web API for MongoDB made with
Table of Contents
- How to Build
- Integration Tests
- Maven Dependencies
- Continuous Integration
Refer to restheart.org/learn/setup for detailed information on how to setup RESTHeart.
How to Build
Building RESTHeart requires Maven.
Clone the repository and update the git submodules. RESTHeart includes the HAL browser as a submodule:
$ git submodule update --init --recursive
Build the project with Maven:
$ mvn clean package
To run the integration test suite, first make sure that mongod is running on localhost, on default port 27017 and without authentication enabled — i.e. no
--auth option is specified.
$ mvn verify -DskipITs=false
Alternatively, if you have Docker, execute the following script:
The script starts a Docker container running MongoDB and then execute the integration tests with Maven. It will clean-up the container at the end.
RESTHeart's releases are available on Maven Central.
Stable releases are available at:
If you want to embed RESTHeart in your project, add the dependency to your POM file:
<dependencies> <dependency> <groupId>org.restheart</groupId> <artifactId>restheart</artifactId> <version>3.3.0</version> </dependency> </dependencies>
Snapshots are available at Sonatype. If you want to build your project against a development release, first add the SNAPSHOT repository:
<repositories> <repository> <id>restheart-mvn-repo</id> <url>https://oss.sonatype.org/content/repositories/snapshots</url> <snapshots> <enabled>true</enabled> <updatePolicy>always</updatePolicy> </snapshots> </repository> </repositories>
Then include the SNAPSHOT dependency in your POM:
<dependencies> <dependency> <groupId>org.restheart</groupId> <artifactId>restheart</artifactId> <version>3.4.0-SNAPSHOT</version> </dependency> </dependencies>
An automatically generated Maven Site for each build of the
master branch is available at: http://softinstigate.github.io/restheart/
We continually integrate and deploy development releases to Maven Central with Travis-CI.
RESTHeart's public Docker images are also automatically built and pushed to Docker Hub. The
latest tag for Docker images refers to the most recent SNAPSHOT release on the