Skip to content

Commit

Permalink
💄 Add dividers to faq page
Browse files Browse the repository at this point in the history
  • Loading branch information
ujibang committed Jan 4, 2024
1 parent 587c59e commit 65a14c6
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 1 deletion.
2 changes: 1 addition & 1 deletion _includes/docs-sidebar.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ <h2 class="mt-2">MongoDB Plugins</h2>
</a>
<ul id="mongodb" class="collapse">
<h3 id="rest-api" class="mt-2">REST API</h2>
<li><a href="/docs/mongodb-rest/tutorial">Tutorial</a></li>
<li><a href="/docs/mongodb-rest/tutorial">Tutorial</a></li>
<li><a href="/docs/mongodb-rest/read-docs">Read Documents</a></li>
<li><a href="/docs/mongodb-rest/write-docs">Write Documents</a></li>
<li><a href="/docs/mongodb-rest/files">Binary Files with GridFS</a></li>
Expand Down
18 changes: 18 additions & 0 deletions docs/faq.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,16 @@ It provides features commonly needed by applications like authentication/authori

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

'''

### 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.
Expand All @@ -26,18 +30,26 @@ The complete codebase is open source, and there are no distinctions in features

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

'''

### 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?

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?

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.

'''

### How can I extend the API?

A plugin is a software component that extends the functionality of RESTHeart, allowing you to add additional features and capabilities to the basic API. RESTHeart supports the development of plugins in Java, Kotlin, and JavaScript.
Expand All @@ -52,6 +64,8 @@ Once the plugin is added and RESTHeart is restarted, it will be automatically de

Please note that for JavaScript plugins, you need to run RESTHeart on GraalVM or on RESTHeart native.

'''

### What categories of plugins are available?

There are four types of plugins in RESTHeart:
Expand All @@ -63,12 +77,16 @@ There are four types of plugins in RESTHeart:

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

'''

### What about performances?

In RESTHeart 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.

'''

### 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.
Expand Down

0 comments on commit 65a14c6

Please sign in to comment.