Spring Boot Basics - Introduction To Spring Data Rest


Spring Data project provides common abstractions to integrate with different kinds of data stores. Spring Data Rest is part of the umbrella of Spring Data projects. It makes it easy to build hypermedia-driven REST web services, on top of Spring Data repositories.

You will learn

  • What is Spring Data Rest?
  • How does Spring Data Rest make building REST API easier?
  • How to integration Spring Data Rest with Spring Data JPA?
  • What are important features of Spring Data Rest?
  • How to execute REST API created using Spring Data Rest?

What Does Spring Data Rest Do?

It does all of the following:

  • Exposes REST services around the Spring Data, without having to write a lot of code.
  • Supports both SQL-based and No SQL-based databases.
  • Supports Pagination
  • Enables Filtering
  • Allows for Sorting
  • Supports HATEOAS

Why Spring Data Rest

Spring Data Rest is ideal for simple projects, that quickly want to get started with creating REST API.

Let’s look at a quick example of using Spring Data Rest to build a REST API.

Generate your project

The easiest way to bring such projects up, would be to use the Spring Initializr:

image info

Note that we have included the dependencies such as Web, JPA and Rest Repositories.You can generate the project, and then import it as a maven project into Eclipse IDE.

Create Entity

Once you have the project imported into eclipse, lets create a JPA Entity - Todo:

image info

@Entity Todo has an Id, and has a few fields and methods.

Create RepositoryRestResource

Once you have an entity, you can create a RepositoryRestResource for it.


	@RepositoryRestResource(collectionResourceRel="todos", path="todos")
	public interface TodoRepository 
					extends PagingAndSortingRepository<Todo, Long> {
		List<Todo> findByUser(@Param("user") String user);
	}
	

Testing REST API

Once you have the Entity and RepositoryRestResource, you are ready to fire your requests.

For example, you can send a POST request to a URL to create a resource:

image info

You can see that the link of the created resource is returned to you.

Another thing you can do is go to the URL and see what resources are currently stored there: image info

You can also access a specific todo stored in the repository: image info

You can do a search on the repository by typing in a query such as: https://localhost:8080/todos?user="Jill"

You can also do a search by directly invoking the repository method: https://localhost:8080/search/findByUser?user="Jill"

When to use Spring Data Rest?

Remember to use Spring Data Rest only for simple projects. It is great to use when you are building a prototype for your application. However, when it comes to production applications, you need to think twice before using Spring Data Rest.

Do check out our video on the same topic:

image info

Summary

In this article, we had a look at Spring Data Rest, which is a framework used to build REST services around Spring Data repositories. It is ideal to use with simple applications or prototypes.

Related Posts

Spring Boot Tutorials for Beginners

At in28Minutes, we are creating a number of tutorials with videos, articles & courses on Spring Boot for Beginners and Experienced Developers. This resources will help you learn and gain expertise at Spring Boot.

Spring Boot Basics - What Is A Profile?

When we develop applications, we would want to be able to provide different application configuration in different environments? How do you achieve it with Profiles?

Spring Basics - What Is A Dependency?

Most important feature of Spring Framework is Dependency Injection. To understand Dependency Injection, you need to understand the concept of a Dependency.

Architecture of Spring Framework - Modularity and Spring Modules

One of the most important features of the Spring framework is its modularity. It is not one big monolith framework. What are Spring Modules? How are they organized? What is the architecture of Spring Framework?

What Are Spring Projects?

There are several important Spring Projects solving the needs of enterprises today. What are Spring Projects and how are they different from Spring Modules?

Spring Basics - Introduction To Spring Batch

Spring Batch is a lightweight, comprehensive batch framework that is designed for use in developing robust batch applications.

Spring Framework Basics - What Is Inversion Of Control?

Developers starting with the Spring framework often get confused with terminology - Dependency, Dependency Injection and Inversion Of Control. In this article, we introduce you to the concept of Inversion of Control.

Spring Boot Basics - Introduction To Spring Data and Spring Data JPA

In this article, we take a look at Spring Data and Spring Data JPA.

Spring Basics - Introduction To Spring Framework

In this article, we look to get an introduction to what the Spring framework is, and why it is so widely used.

Introduction To Spring Boot Framework

In this article, we understand the basics of Spring Boot framework. We look at the important features of Spring Boot and how it is different from the Spring framework.