RESTHeart Documentationversion 3.xAuthorsAndrea Di Cesare, Maurizio Turatti RESTHeart is an open source project created and developed by SoftInstigate. |
What's New in 3.x
|
If you have questions please post them as Github issues or on Stackoverflow. |
RESTHeart is the Web API for MongoDB. Just start it to open MongoDB to the Web via a clean, secure and complete RESTful API.
RESTHeart leverages MongoDB's document-oriented nature, creating an automatic mapping between MongoDB's internal storage of data and a graph of externally accessible HTTP resources, implementing a model of interaction compliant with an HATEOAS (Hypermedia as the Engine of Application State) representation, where the state of a client process is entirely driven by HTTP verbs like GET, POST, PUT, PATCH, DELETE, etc.
RESTHeart seamlessly connects to MongoDB to securely expose dbs and collections to the web.
Any authorized client (authentication and authorization are provided out-of-the-box) can interact with MongoDB via the RESTHeart API.
documents are read with the GET verb, created and modified with PUT, POST and PATCH verbs and deleted with the DELETE verb.
Data is exchanged as JSON (actually the standard hal+json mediatype).
HAL is a simple format that gives a consistent and easy way to hyperlink between resources in your API.
The following picture depicts a simple usage scenario: a mobile blog reader application sends a GET /blog/posts request to retrive the paginated list of posts.
RESTHeart is implemented in Java 8, on top of the Undertow HTTP server. The complete source code is available on Github.