v9 (current) v8
Edit Page

RESTHeart v9 Documentation RESTHeart Cloud

Welcome to RESTHeart v9! This documentation is organized to help you learn progressively and find information quickly.

🚀 Quick Start

New to RESTHeart? Start here:

Quick Start →

Get RESTHeart running in 5 minutes.

Note
Upgrading from RESTHeart v8 or earlier?

📦 RESTHeart v9 brings major improvements! Java 25, OAuth 2.0 authentication, enhanced security, custom metrics, and more.

👉 Read the Upgrade Guide for migration instructions and breaking changes.

📚 Learning Paths

Choose the path that matches your goal:

Path 1: MongoDB API User (No Coding Required)

Goal: Build applications using RESTHeart’s MongoDB APIs without writing backend code.

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

Security Tutorial (30 min)

9

User Management (20 min)

10

Permissions (30 min)

11

Configuration (20 min)

✓ You’re now ready to deploy a production MongoDB API!

Next steps: Explore Transactions, File Storage, Schema Validation

Path 2: Plugin Developer

Goal: Extend RESTHeart with custom services and interceptors.

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: Try JavaScript Plugins, learn Initializers, explore Security Plugin Development

Path 3: 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: Optimize with GraalVM Native Image, set up Auditing, configure Reverse Proxy

Path 4: 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: Learn Performance Optimization, study Advanced Example, review Best Practices

📖 Browse Documentation by Topic

Prefer to explore on your own? Browse by topic:

Part 1: Foundations

Introduction, installation, core concepts, and security fundamentals.

Start here if you’re new to RESTHeart.

Part 2: MongoDB REST API

Complete guide to the REST API - CRUD, queries, aggregations, transactions, and performance.

Read this to use RESTHeart’s MongoDB API without coding.

Part 3: GraphQL & WebSocket APIs

GraphQL API for flexible queries and WebSocket API for real-time data.

Alternative APIs for specific use cases.

Part 4: Security

User management, authentication methods, authorization, and production security.

Essential for securing your APIs.

Part 5: Configuration & Deployment

Configuration options, deployment scenarios, operations, and performance tuning.

Deploy RESTHeart to production.

Part 6: Extending RESTHeart

Plugin development - Services, Interceptors, Providers, and Initializers.

Build custom functionality with the framework.

Part 7: Extending Security

Develop custom authentication and authorization plugins.

Extend the security layer.

Part 8: RESTHeart Cloud

RESTHeart Cloud features, Sophia AI, and webhooks.

Use the managed cloud offering.

Part 9: Reference

API reference, migration guides, FAQ, examples, and resources.

Quick reference and additional resources.

⚡ Quick Start

Get running in 5 minutes

❓ FAQ

Common questions answered

💡 Examples

Sample applications

🎮 Live Demo

Try the demo app

🎓 Tutorials

Hands-on guides to get you started:

🌟 Why RESTHeart?

  • Zero Code Required - Use MongoDB APIs out of the box

  • Instant APIs - REST, GraphQL, WebSocket for MongoDB

  • Secure by Default - Built-in authentication and authorization

  • Highly Extensible - Simple plugin system in Java, Kotlin, or JavaScript

  • High Performance - Virtual threads for massive scalability

  • Cloud Ready - Docker, Kubernetes, GraalVM native images

💬 Community & Support

📰 Stay Updated

Ready to dive in? Choose a learning path or jump straight to the Quick Start!