Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add spring integration configuration doc #5053

Merged
merged 1 commit into from
Oct 2, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
66 changes: 65 additions & 1 deletion integrations/spring/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,68 @@ This project includes three primary modules:

- opendal-spring: Core integration module for [Spring](https://spring.io/) applications.
- opendal-spring-boot-starter: Synchronous starter for [Spring WebMVC](https://docs.spring.io/spring-framework/reference/web/webmvc.html).
- opendal-spring-boot-starter-reactor: Asynchronous starter for [Spring WebFlux](https://docs.spring.io/spring-framework/reference/web/webflux.html).
- opendal-spring-boot-starter-reactive: Asynchronous starter for [Spring WebFlux](https://docs.spring.io/spring-framework/reference/web/webflux.html).

## Features

- SpringBoot autoconfiguration support for an OpenDALTemplate/ReactiveOpenDALTemplate instance.

## Prerequisites

This project requires JDK 17 or later and supports Spring 6 and Spring Boot 3.

## Getting Started With Spring Boot Starter

Below is a brief example demonstrating how to use the OpenGemini Spring Boot Starter in a Java application.

### Maven Configuration

Add the following dependency to your project's `pom.xml`:

```xml
<dependency>
<groupId>org.apache.opendal</groupId>
<artifactId>opendal-spring-boot-starter</artifactId>
<version>${version}</version>
</dependency>
```

### SpringBoot Application Configuration

Following properties can be used in your `application.yaml`:

```yaml
spring:
opendal:
schema: "fs"
conf:
root: "/tmp"
```

## Getting Started With Spring Boot Reactive Starter

Below is a brief example demonstrating how to use the OpenGemini Spring Boot Starter in a Java application.

### Maven Configuration

Add the following dependency to your project's `pom.xml`:

```xml
<dependency>
<groupId>org.apache.opendal</groupId>
<artifactId>opendal-spring-boot-starter-reactive</artifactId>
<version>${version}</version>
</dependency>
```

### SpringBoot Reactive Application Configuration

Following properties can be used in your `application.yaml`:

```yaml
spring:
opendal:
schema: "fs"
conf:
root: "/tmp"
```
Loading