Skip to content

Commit

Permalink
📝 Add FAQ
Browse files Browse the repository at this point in the history
  • Loading branch information
ujibang committed Nov 24, 2023
1 parent 21cd2e2 commit 25d198d
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 17 deletions.
1 change: 1 addition & 0 deletions _includes/header.html
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ <h2 class="text-white"><strong>REST</strong>Heart<small>®</small></h2>
<a class="github-button" href="https://github.com/SoftInstigate/restheart" data-size="large" data-show-count="true" aria-label="Star SoftInstigate/restheart on GitHub"></a>
</li>
<li class="nav-item"><a class="ml-1 ml-lg-2 ml-xl-4" href="{{ "/docs" | prepend: site.baseurl }}">Docs</a></li>
<li class="nav-item"><a class="ml-1 ml-lg-2 ml-xl-4" href="{{ "/faq" | prepend: site.baseurl }}"><strong>FAQ</strong></a></li>
<li class="nav-item"><a class="ml-1 ml-lg-2 ml-xl-4" href="{{ "/docs/try/" | prepend: site.baseurl }}"><strong>Try online</strong></a></li>
<li class="nav-item"><a class="ml-1 ml-lg-2 ml-xl-4" href="{{ "/docs/setup/" | prepend: site.baseurl }}"><strong>Download</strong></a></li>
<li class="nav-item"><a class="ml-1 ml-lg-2 ml-xl-4" href="{{ "/#features" | prepend: site.baseurl }}">Features</a></li>
Expand Down
32 changes: 15 additions & 17 deletions faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -3,45 +3,47 @@ title: RESTHeart FAQ
layout: docs-adoc
---

## What is RESTHeart?
### What is RESTHeart?

RESTHeart is a framework for building HTTP microservices that aims to empower developers with intuitive APIs out of the box. It is built for developers, with a focus on simplicity, speed and ease of use.

It provides features commonly needed by applications like authentication/authorization and data management through MongoDB integration.

It has a modular architecture where core functionality is provided by restheart-core, and additional features are implemented as plugins.

## Is it Open Source?
### In which programming language is RESTHeart written?

RESTHeart is primarily written in Java. Thanks to GraalVM, its SDK extends support to Java, Kotlin, JavaScript, and TypeScript. Implementing Hello World examples in any of these languages is straightforward.

Furthermore, RESTHeart is available and can be built with custom plugins as a binary executable, allowing for additional flexibility.

### Is it Open Source?

Absolutely! RESTHeart is released under the AGPL Open Source License, along with an Enterprise License.

The complete codebase is open source, and there are no distinctions in features between the AGPL and Enterprise License.

The Enterprise License is specifically designed for organizations seeking extra assurances and professional support.

## How does it support MongoDB?
### How does it support MongoDB?

The MongoDB plugin exposes the full database capabilities through REST, GraphQL and Websockets with no backend code required. This cuts development time significantly.

## What security features are supported?
### What security features are supported?

RESTHeart offers comprehensive authentication and authorization services, supporting various security schemes. It enables the management of users and permissions directly in MongoDB collections, eliminating the need for backend code. This streamlined approach significantly reduces development time.

## Why restheart is classified as a low code framework?
### Why restheart is classified as a low code framework?

RESTHeart is classified as a low-code framework because it offers developers customizable APIs that are ready to go. It aims to empower developers with an intuitive framework that encompasses essential features, allowing them to build applications without the need to reinvent the wheel. RESTHeart provides pre-configured APIs that cover a broad range of functionality and are highly customizable to fit specific application needs. This approach reduces the amount of code developers need to write, streamlining the development process and making it easier and faster to build cloud-native HTTP microservices.

## Which languages the SDK support?

RESTHeart SDK supports Java, Kotlin, JavaScript and TypeScript. Hello World examples are very simple to implement in any of these languages.

## What about performances?
### What about performances?

Performance is a priority with support for huge throughput, horizontal scaling, and GraalVM for better performance in containers.

It is designed for microservices deployment in Docker/Kubernetes and can run as a standalone JAR, native binary or Docker image.

## What categories of plugins are available?
### What categories of plugins are available?

There are four types of plugins in RESTHeart:

Expand All @@ -52,14 +54,10 @@ There are four types of plugins in RESTHeart:

Additionally, it is also possible to develop security plugins to customize the security layer.

## Does the SDK provide a Dependency Injection feature?
### Does the SDK provide a Dependency Injection feature?

Yes! Dependency injection in RESTHeart works by using the `@Inject` and `@OnInit` annotations in conjunction with provider classes.

To implement dependency injection, a provider class must implement the `Provider` interface and be annotated with `@RegisterPlugin`. The provider class provides the object that will be injected into other classes.

Overall, dependency injection in RESTHeart allows for the easy injection of provided objects into other classes, reducing the need for manual object creation and management.




Overall, dependency injection in RESTHeart allows for the easy injection of provided objects into other classes, reducing the need for manual object creation and management.

0 comments on commit 25d198d

Please sign in to comment.