From the command line
Use curl or httpie to play with our demo instance.
See below for a step by step tutorial.
Using the HAL browser
Go and play with it on our demo instance at
Try it from the command line
The demo database exposes a the messages collection at
https://api.mrest.io without requiring authentication. Access to any other MongoDB resource is forbidden.
mrest.io is an upcoming managed service for RESTHeart.
This demo instance is reset on regular basis, so feel free to play with it but don’t rely on it for persistent storage of your data.
Insert or update the document with _id docid
Get the created document
Create a second document with
If the _id is not specified in the request body, it will be autogenerated as a new ObjectId. The
Location response header specifies the URL of the new document.
Update the first document with
This request uses the dot notation and the
$currentDate operator. These are available in all write requests!
Get the updated document again.
The returned representation contains all the document properties plus few more. The
_etag is updated automatically by RESTHeart for Web caching and ghost writes management.
Find documents via query.
filter query parameter allows to specify any MongoDB query.
This instance of RESTHeart is configured to always add the
np query parameter to the request; it gets rid of the collection properties and
returns just an array of documents.