Skip to content

SoftInstigate/restheart

master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
Nov 28, 2022
Nov 28, 2022
Nov 28, 2022
Nov 28, 2022
Nov 28, 2022
Oct 13, 2022
Nov 28, 2022

RESTHeart - Ready to use backend for the modern Web.

REST, GraphQL and WebSocket APIs for MongoDB.

GitHub last commit Github stars Maven Central Docker Pulls Join the chat at https://gitter.im/SoftInstigate/restheart

RESTHeart provides:

  1. Out of the box data persistence on MongoDB and any compatible database, like AWS DocumentDB or Azure Cosmos DB, with REST, GraphQL and WebSocket APIs.
  2. Declarative authentication, authorization and user management for your applications.
  3. Polyglot development framework supporting Java, Kotlin, JavaScript and TypeScript.

With RESTHeart you can access 100% of MongoDB capabilities with plain HTTP calls, no programming is needed!

Note: Book a free 1-to-1 demo and ask us anything!

At startup, RESTHeart connects automatically to the configured MongoDB database and exposes it via a complete API. See the below example session that uses HTTPie for REST calls:

RESTHeart in action

Developers can save at least 80% of backend code to manage security and serve content to Mobile Apps, Angular, React, Vue or other SPA frameworks.

RESTHeart use cases

Advanced features

RESTHeart embeds Undertow, a flexible and performant web server written in Java, providing both blocking and non-blocking HTTP API’s based on NIO. Undertow is the underlying HTTP server of RedHat's Wildfly.

RESTHeart works out-of-the-box by merely installing and configuring it. It is particularly suitable to run as a Docker container, so it works perfectly in Kubernetes and AWS ECS clusters.

RESTHeart also supports GraalVM, a new Java Virtual Machine from Oracle that offers a polyglot runtime environment and the ability to compile Java applications to native binary images.

Ther internal architecture is based on plugins and exposes an API that allows to implement additional custom services in Java, Kotlin, JavaScript or TypeScript.

To extend the default behavior you can implement the following Java interfaces:

  • Service - to develop custom business logic and web services.
  • Interceptor - to intercept and modify requests and responses on the fly, at different stages of the HTTP lifecycle.
  • Initializer - to execute any kind of initialization logic once, at system startup time.

The GraphQL default plugin works side by side with the already existing REST endpoints to get a managed, unified GraphQL API for modern applications.

The embedded WebSocket server can expose MongoDB's Change Streams, which allow applications to access real-time data changes.

For all these reasons, RESTHeart is the perfect "low code", self-contained backend for modern Web and Mobile apps, designed to radically simplify development and deployment.

Download

Download prebuilt packages from releases

Find setup instructions at Setup documentation page.

Build from source

Note: Building RESTHeart from scratch requires at least Java 17 and maven 3.6.

$ ./mvnw clean package

You can then run it with (make sure to have mongod running):

$ java -jar core/target/restheart.jar core/etc/restheart.yml -e core/etc/default.properties

Automatic snapshot builds

Snapshot builds are available from sonatype.org

Docker images of snapshots are also available:

$ docker pull softinstigate/restheart-snapshot:[commit-short-hash]

For commit short hash you need the first 7 digits of the hash, e.g.

$ git log

commit 2108ce033da8a8c0b65afea0b5b478337e44e464 (HEAD -> master, origin/master, origin/HEAD)
Author: Andrea Di Cesare <andrea@softinstigate.com>
Date:   Fri Oct 22 12:46:00 2021 +0200

    :bookmark: Bump to version 6.2.0-SNAPSHOT

...

The short hash is 2108ce0 and the docker pull command is therefore

$ docker pull softinstigate/restheart-snapshot:2108ce0

Documentation

The full documentation is available here.

You can also have a look at our introductory video on Youtube:

Watch the video!

Contacts and Support

Become a Sponsor

You can support the development of RESTHeart via the GitHub Sponsor program and receive public acknowledgment of your help.

Go and see available sponsor tiers.

Sponsors


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