The API Service for the Modern Web
Instant Data APIs on MongoDB, Declarative Access Control
and Polyglot Development Framework
Blazing fast Instant REST, GraphQL and WebSocket API on MongoDB Develop custom Web Services Handle Users and Permissions with no code Extensible with Java, Kotlin, JavaScript & TypeScript Deliver any content to the Web Available as a Docker image Run and build it with java or as a native binary Proxy External Resources Notify clients with Hooks Threat protection at every layer
Featured on MongoDB.com
RESTHeart API for MongoDB simplifies development and frees you to focus on delivering great user experiences
READ THE POSTBuild modern apps
RESTHeart connects automatically to MongoDB or any compatible database (e.g. Percona Server for MongoDB, AWS DocumentDB and Azure Cosmos DB) exposing all database's features through a comprehensive set of web services.
- Instant REST, GraphQL and WebSocket API
- Built-in Authentication and Authorization
- Java, Kotlin, JavaScript and TypeScript Framework to extend the API
Setup in minutes
RESTHeart fully supports GraalVM, a new virtual machine from Oracle that offers a polyglot runtime environment and the ability to compile Java applications to native images. RESTHeart is also available as a Docker image, so it works perfectly in Kubernetes and AWS ECS.
- Ready-to-run stateless Microservice
- Available as JAR, native binary and Docker imagine
- Deployable both on cloud and on premises
Ready to use data API for MongoDB
Query documents from the command line with httpie.
The GET request has two query parameters: filter to apply a query and pagesize to limit the response to two documents.
Here we use the brilliant httpie, a modern command line HTTP client.
$ http GET https://demo.restheart.org/messages?filter='{"from":"Bob"}'\&pagesize=2
HTTP/1.1 200 OK
# other response headers omitted
[
{
"_id": {
"$oid": "5c50963e477870eb8258fa68"
},
"from": "Bob",
"message": "was here",
"timestamp": {
"$date": 1548785214114
}
},
{
"_id": {
"$oid": "5c50962f477870eb8258fa54"
},
"from": "Bob",
"message": "RESTHeart rocks",
"timestamp": {
"$date": 1548785199983
}
}
]Query documents from the command line with cURL.
The GET request has two query parameters: filter to apply a query (that needs to be encoded with --data-urlencode option since it contains the curly brackets) and pagesize to limit the response to two documents.
Here we use the immortal cURL!
$ curl -G --data-urlencode 'filter={"from":"Bob"}' https://demo.restheart.org/messages?pagesize=2
[
{
"_id": {
"$oid": "5c50963e477870eb8258fa68"
},
"from": "Bob",
"message": "was here",
"timestamp": {
"$date": 1548785214114
}
},
{
"_id": {
"$oid": "5c50962f477870eb8258fa54"
},
"from": "Bob",
"message": "RESTHeart rocks",
"timestamp": {
"$date": 1548785199983
}
}
]Query documents with JavaScript.
The GET request has two query parameters: filter to apply a query and pagesize to limit the response to two documents.
Here we use the fetch API.
const url = encodeURI('https://demo.restheart.org/messages?filter={"from":"Bob"}&pagesize=2');
fetch(url)
.then(response => response.json())
.then(json => JSON.stringify(json, null, 2))
.then(docs => console.log(docs));Query documents with Java.
The GET request has two query parameters: filter to apply a query and pagesize to limit the response to two documents.
Here we use the unirest java http library.
public void printOutMessages() throws UnirestException {
var resp = Unirest.get("https://demo.restheart.org/messages")
.queryString("filter", "{\"from\":\"Bob\"}")
.queryString("pagesize", "2")
.asJson();
// get body as JSON array
var messages = resp.getBody().getArray();
// print out each message
messages.forEach(msg -> System.out.println(msg.toString()));
}Query documents with Swift.
The GET request has two query parameters: filter to appy a query and pagesize to limit the response to two documents.
Here we use the JSONSerialization to parse the response body.
import UIKit
import PlaygroundSupport
var urlComponents = URLComponents(string: "https://demo.restheart.org/messages")
// set the query parameters
var queryItems = [URLQueryItem]()
queryItems.append(URLQueryItem(name: "pagesize", value: "2"))
queryItems.append(URLQueryItem(name: "filter", value: "{\"from\":\"Bob\"}"))
urlComponents?.queryItems = queryItems
var urlRequest = URLRequest(url: (urlComponents?.url)!)
// set request method
urlRequest.httpMethod = "GET"
URLSession.shared.dataTask(with: urlRequest) { (data, response, error) in
guard let dataResponse = data, error == nil
else {
print(error?.localizedDescription ?? "Response Error")
return
}
do {
let jsonResponse = try JSONSerialization.jsonObject(with: dataResponse, options: [])
print(jsonResponse)
} catch let jsonError {
print(jsonError)
}
}.resume()
// only needed in playground
PlaygroundPage.current.needsIndefiniteExecution = trueJava, Kotlin and JavaScript framework to extend the API
Implement web services in minutes.
Implement a simple interface and deploy the web service by copying its jar file into the plugins directory.
More examples@RegisterPlugin(name = "greeterService",
description = "sends a greetings message",
defaultURI = "/greetings")
public class GreeterService implements JsonService {
@Override
public void handle(JsonRequest request, JsonResponse response) {
if (request.isGet()) {
var content = new JsonObject();
content.addProperty("message", "Hello World!");
response.setContent(content);
} else {
response.setStatusCode(400);
}
}
}Implement plugins in Kotlin.
You can use Java and Kotlin to implement plugins.
Kotlin Service example@RegisterPlugin(name = "kotlinGreeterService",
description = "sends a greetings message, implemented in Kotlin",
defaultURI = "/greetings")
class GreeterServiceKt : JsonService {
override fun handle(request: JsonRequest?, response: JsonResponse?) {
if (request?.isGet!!) {
var greetings = JsonObject()
greetings.addProperty("msg", "Hello World!")
response?.content = greetings;
} else {
response?.statusCode = 400;
}
}
}Snoop and modify requests at different stages of their lifecycle.
This interceptor applies to requests of the hello web service adding a timestamp to the response content.
Interceptor can be executed at different points of the request as defined
by the interceptPoint parameter of the annotation RegisterPlugin
@RegisterPlugin(name = "helloInterceptor",
description = "add a timestamp to the response of /hello",
interceptPoint = InterceptPoint.RESPONSE)
public class HelloInterceptor implements JsonInterceptor {
@Override
public void handle(JsonRequest request, JsonResponse response) throws Exception {
// add timestamp property to the response
response.getContent()
.getAsJsonObject()
.addProperty("timestamp", Instant.now().toString());
}
@Override
public boolean resolve(JsonRequest request, JsonResponse response) {
// apply for request handled by hello service
// when the response content is a JSON Object
return request.isHandledBy("hello")
&& response.getContent() != null
&& response.getContent().isJsonObject();
}
}Implement plugins in JavaScript.
This is yet another Hello World web service.
Running RESTHeart on the GraalVM allows you to deploy JavaScript Services and Interceptors.
export const options = {
name: "helloWorldService",
description: "just another Hello World",
uri: "/hello"
}
export function handle(request, response) {
response.setContent(JSON.stringify({ msg: 'Hello World' }));
response.setContentTypeAsJson();
}
Introducing HTTP Shell
A new Open Source gem from SoftInstigate
More..Trusted by Startups and Corporations
Widely Adopted
RESTHeart Docker image's pulls
Our speech about RESTful MongoDB Transactions at MongoDB Live 2020
