Get started
Learning Paths
Seven reading orders through the documentation, one for each kind of application. Each lists the pages to read, in order, with the time they take.
A learning path is a reading order: the pages to read for one kind of application, from the first concept to something running in production.
The first four paths cover what RESTHeart gives an application without backend code. The last three are for extending it with plugins and for running it.
New to RESTHeart? The Introduction and the Quick Start come before any path.
Path 1: Build on MongoDB, No Backend Code
Goal: Read, write, aggregate and validate data through RESTHeart’s APIs, with rules enforced by the server.
Time: ~4 hours | Difficulty: Beginner
| Step | Topic |
|---|---|
1 |
What is RESTHeart? (10 min) |
2 |
Quick Start (15 min) |
3 |
Security Fundamentals (20 min) |
4 |
REST API Tutorial (30 min) |
5 |
Reading Data (30 min) |
6 |
Writing Data (30 min) |
7 |
Aggregations (20 min) |
8 |
Data Constraints (20 min) |
9 |
Change Streams (15 min) |
10 |
Permissions (30 min) |
11 |
Configuration (20 min) |
✓ You can now run a production API on MongoDB.
Next steps: Transactions, File Storage, Schema Validation
Path 2: Users, Sign-up and Teams
Goal: Give your application sign-up, login, social sign-in, password reset, teams and invitations — with the restheart-accounts plugin, not with code of yours.
Time: ~2 hours | Difficulty: Beginner
| Step | Topic |
|---|---|
1 |
Sign-up Management Overview (10 min) |
2 |
Tutorial: Set Up Registration (30 min) |
3 |
User Registration and Verification (15 min) |
4 |
Password Reset (10 min) |
5 |
Email Templates (15 min) |
6 |
Sign in with Google and GitHub (20 min) |
7 |
Teams and Invitations (15 min) |
8 |
Multi-tenancy (15 min) |
9 |
Terms and Consents (10 min) |
✓ Your users can register, sign in and work in teams.
Path 3: AI Agents and Semantic Search
Goal: Let an AI agent use your data over MCP, and search it by meaning with vector search — the restheart-ai plugin.
Time: ~2 hours | Difficulty: Intermediate
| Step | Topic |
|---|---|
1 |
AI Features Overview (10 min) |
2 |
The MCP Server (20 min) |
3 |
|
4 |
Connect Claude Desktop (10 min) |
5 |
API Keys: a Credential for an Agent (15 min) |
6 |
Vector Search (20 min) |
7 |
✓ An agent answers questions on your data, and your search understands meaning.
Path 4: Subscriptions and Billing with Stripe
Goal: Sell plans and seats, gate features by plan, and keep subscriptions in step with Stripe — the restheart-stripe plugin.
Time: ~2 hours | Difficulty: Intermediate
| Step | Topic |
|---|---|
1 |
Stripe Integration Overview (10 min) |
2 |
Tutorial: Set Up Stripe (30 min) |
3 |
Products and Prices (15 min) |
4 |
Plans and Seats (20 min) |
5 |
Plan Gates (15 min) |
6 |
Subscription Lifecycle (15 min) |
7 |
Webhooks (15 min) |
8 |
Multi-tenancy (10 min) |
✓ Your application charges, and knows who paid for what.
Next steps: Subscription Owner Provider, Teams and Invitations
Path 5: Plugin Developer
Goal: Extend RESTHeart with custom services, interceptors and providers, in Java, Kotlin, JavaScript or TypeScript.
Time: ~3 hours | Difficulty: Intermediate
| Step | Topic |
|---|---|
1 |
What is RESTHeart? (10 min) |
2 |
Quick Start (15 min) |
3 |
Core Concepts (30 min) |
4 |
Framework Overview (20 min) |
5 |
Plugin Tutorial (45 min) |
6 |
Developing Services (30 min) |
7 |
Developing Interceptors (20 min) |
8 |
Providers & Dependency Injection (15 min) |
9 |
Deploying Plugins (20 min) |
✓ You can now build and deploy custom plugins.
Next steps: JavaScript Plugins, Initializers, Sending email from a plugin
Path 6: DevOps / Site Reliability Engineer
Goal: Deploy and operate RESTHeart in production.
Time: ~2 hours | Difficulty: Intermediate
| Step | Topic |
|---|---|
1 |
What is RESTHeart? (10 min) |
2 |
Installation (20 min) |
3 |
Docker Setup (20 min) |
4 |
Configuration (30 min) |
5 |
Security Hardening (20 min) |
6 |
TLS Configuration (15 min) |
7 |
Logging (10 min) |
8 |
Monitoring (15 min) |
9 |
Clustering & Load Balancing (20 min) |
✓ You’re ready to run RESTHeart in production.
Next steps: GraalVM Native Image, Auditing, Reverse Proxy
Path 7: GraphQL Developer
Goal: Build GraphQL APIs on top of MongoDB.
Time: ~2 hours | Difficulty: Intermediate
| Step | Topic |
|---|---|
1 |
What is RESTHeart? (10 min) |
2 |
Quick Start (15 min) |
3 |
GraphQL Tutorial (30 min) |
4 |
Getting Started (20 min) |
5 |
GraphQL Apps (20 min) |
6 |
Schema Design (20 min) |
7 |
Mappings (20 min) |
8 |
Resolvers (20 min) |
✓ You can now build GraphQL APIs with RESTHeart.
Next steps: Performance Optimization, Advanced Example, Best Practices
Tutorials
Hands-on guides, one per feature, each from a blank service to something working:
-
REST API Tutorial — the REST API through examples
-
GraphQL Tutorial — build a GraphQL API
-
WebSocket Tutorial — real-time data with WebSockets
-
SSE Tutorial — server-push streams over plain HTTP
-
Security Tutorial — set up authentication and authorization
-
Registration Tutorial — sign-up, verification and password reset with
restheart-accounts -
MCP Tutorial — publish your data to an AI agent, then connect Claude Desktop
-
Vector Search Tutorial — semantic search on your own documents
-
Stripe Tutorial — subscriptions and payments with
restheart-stripe -
Webhook Tutorials — notify Slack, Discord or your own endpoint from Ulabase
-
Plugin Development Tutorial — build your first plugin
Community and support
-
GitHub: SoftInstigate/restheart
-
Examples: Plugin examples on GitHub
-
Enterprise Support: Enterprise License and Support
Stay updated
-
Blog Posts - Technical articles and announcements
-
Roadmap - Upcoming features