/Spring-Data-OpenSearch-Example

Primary LanguageJava

Spring Data OpenSearch Example with Spring Boot 3 and OpenSearch 1.1

Introduction

This example demonstrates how to use Spring Data OpenSearch to do simple CRUD operations.

This example inspired be the Spring-Data-ElasticSearch-Example

You can find the tutorial about this example at this link: Getting started with Spring Data OpenSearch

For this example, we created a Book controller that allows doing the following operations with OpenSearch:

  • Get the list of all books
  • Create a book
  • Update a book by Id
  • Delete a book by Id
  • Search for a book by ISBN
  • Fuzzy search for books by author and title

How to run

The first thing to do is to start OpenSearch. For that, you can use the docker-compose file in the develop-scripts directory and run it like this:

$ cd develop-scripts && docker-compose -f docker-compose up -d

It brings OpenSearch up with its dashboard.

Then you can run the application like below:

$ ./mvnw spring-boot:run

Once everything is up and running open the browser and go to http://localhost:8080. You should see Swagger to interact with.

Run Testcontainers tests

The integration tests are written relying on Testcontainers to spin up OpenSearch on the spot and run tests against it.

To run the integration test (using Testcontainers) just run the below command:

$ mvn clean verify

Make sure you have your docker running.