RESTHeart

RESTHeart is a Java backend framework that facilitates the rapid development of REST, GraphQL, and WebSocket APIs, leveraging MongoDB for data storage.

Who Benefits from RESTHeart?

RESTHeart is designed for:

• Developers seeking a low-code solution to build scalable, secure, and high-performance APIs.
• Teams aiming to reduce development time and complexity when working with MongoDB.
• Businesses looking for a reliable and efficient way to expose data through REST or GraphQL APIs.

---

⚠ NEWS

MongoDB has officially announced the deprecation of the Atlas Data API and HTTPS Endpoints for Atlas App Services, with complete removal scheduled for September 30, 2025. If your applications rely on these features, RESTHeart is an alternative solutions to ensure uninterrupted service.

---

Key Features

✅ Low-Code Development: Create APIs with minimal coding effort.
✅ Seamless MongoDB Integration: Instantly expose your MongoDB collections via REST, GraphQL, and WebSocket APIs.
✅ Built-in Security: Provides declarative authentication and authorization mechanisms.
✅ High Performance: Utilizes Java 21 Virtual Threads for efficient concurrency.
✅ Customizable: Flexible architecture that adapts to your specific needs.

Compatible Databases

• MongoDB
• MongoDB Atlas Cloud Database
• Percona Server for MongoDB
• FerretDB (*)
• Amazon DocumentDB (*)
• Microsoft Azure CosmosDB (*)

(*) Might be partially compatibile with MongoDB.

Default Configuration

• The default configuration connects to a local MongoDB instance using the connection string mongodb://127.0.0.1.
• To prevent unintentional exposure of all your data, the API root ("/") is, by default, mapped to a database named "restheart". If you want to expose existing databases and collections through the API, you must update your configuration by replacing the default admin password and explicitly mapping your own databases to API endpoints.

Ask Sophia AI!

Before digging the full documentation, our AI assistant Sophia can quickly help you with any question about RESTHeart.

Quick Start with Docker Compose

1. Run both RESTHeart and MongoDB with Docker Compose using the following one-liner:

curl https://raw.githubusercontent.com/SoftInstigate/restheart/master/docker-compose.yml \
  --output docker-compose.yml \
  && docker compose up --pull=always --attach restheart

1. Call RESTHeart's ping service with curl to verify it's running:

curl -i localhost:8080/ping

HTTP/1.1 200 OK
Connection: keep-alive
Access-Control-Allow-Origin: *
X-Powered-By: restheart.org
Access-Control-Allow-Credentials: true
Access-Control-Expose-Headers: Location, ETag, Auth-Token, Auth-Token-Valid-Until, Auth-Token-Location, X-Powered-By
Content-Type: text/plain
Content-Length: 25
Date: Wed, 07 Aug 2024 10:48:23 GMT

Greetings from RESTHeart!

Running Without Docker

1. Download a pre-built binary of RESTHeart from the Releases page.
2. Uncompress the restheart.tar.gz or restheart.zip archive
3. cd restheart
4. Start MongoDB on localhost:27017 and then run RESTHeart with its default configuration:

java -jar restheart.jar

To connect to a MongoDB server running in a remote host, you can quickly modify the configuration with the RHO env var.

Build from Source

To build from source or to run the integration tests suite look at BUILD.md.

Documentation

The full documentation is available on restheart.org/docs.

To explore the APIs, start with:

• The REST Data API Tutorial
• The GraphQL Data API Tutorial

Community Support

• Open an issue on GitHub to report a specific problem.
• Ask technical questions on Stack Overflow.
• Chat with other users on Slack.
• Book a free 1-to-1 demo with us.

Sponsors

If you enjoy using this open-source project, you can support the development of RESTHeart via the GitHub Sponsor program.

---

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