Over the last few years, Spring has been updating its features. Among all of them, there is one Spring Data Rest.
Spring Data REST is made on top of the Spring Data project. Because of that, it is easy to create HAL (Hypertext Application Language) applications.
Let’s see some features of Spring Data Rest:
Here, we will see the basic example of Spring Data Rest and it’s working. I am assuming that you know the basics of Spring Boot. So let’s get started!!
We will be implementing one example using Spring Boot and MySQL, where we will create one User entity and see how the Spring Data Rest is used.
Now before starting we need to add one maven dependency,
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-data-rest</artifactId> </dependency>
Now create one entity User.java
@Data @AllArgsConstructor @NoArgsConstructor @Entity public class User { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) private Long id; private String name; private String email; }
Now create a repository interface for the User entity.
@Repository public interface UserRepository extends JpaRepository<User, Long> { }
Once created the repository, we are done!!!! Yes, you read correctly. We are done. These are the single things we require to do to work with Spring Data Rest basic CRUD application.
Now let’s see what endpoints have been exposed by Spring Data Rest. To check this, you just need to hit get API in either browser or postman. In my case, the port is 8080 so the URL would be h
http://localhost:8080
Once you hit the localhost URL, you will get the following result, which will look like this.
{ "_links" : { "users" : { "href" : "http://localhost:8080/users{?page,size,sort}", "templated" : true }, "profile" : { "href" : "http://localhost:8080/profile"
{ "_links" : { "users" : { "href" : "http://localhost:8080/users{?page,size,sort}", "templated" : true }, "profile" : { "href" : "http://localhost:8080/profile" } } }
The most beneficial part is that it runs the same as the Spring HATEOAS. So you will get the links and recommended links by default.
Now let’s see some endpoints exposed by Spring Data Rest.
Get all users
URL: http://localhost:8080/users
Response:
{ "_embedded" : { "users" : [ { "name" : "Deepak", "email" : "deep@gmail.com", "_links" : { "self" : { "href" : "http://localhost:8080/users/1" }, "user" : { "href" : "http://localhost:8080/users/1" } } }, { "name" : "Prajapati", "email" : "praj@gmail.com", "_links" : { "self" : { "href" : "http://localhost:8080/users/2" }, "user" : { "href" : "http://localhost:8080/users/2" } } } ] }, "_links" : { "self" : { "href" : "http://localhost:8080/users" }, "profile" : { "href" : "http://localhost:8080/profile/users" } }, "page" : { "size" : 20, "totalElements" : 2, "totalPages" : 1, "number" : 0 } }
Get User using pagination and sorting
URL: http://localhost:8080/users?page=0&size=2&sort=name,desc
Response
{ "_embedded" : { "users" : [ { "name" : "Prajapati", "email" : "praj@gmail.com", "_links" : { "self" : { "href" : "http://localhost:8080/users/2" }, "user" : { "href" : "http://localhost:8080/users/2" } } }, { "name" : "Deepak", "email" : "deep@gmail.com", "_links" : { "self" : { "href" : "http://localhost:8080/users/1" }, "user" : { "href" : "http://localhost:8080/users/1" } } } ] }, "_links" : { "self" : { "href" : "http://localhost:8080/users?page=0&size=2&sort=name,desc" }, "profile" : { "href" : "http://localhost:8080/profile/users" } }, "page" : { "size" : 2, "totalElements" : 2, "totalPages" : 1, "number" : 0 } }
Save User
URL: http://localhost:8080/users/
Request Body:
{ "name":"Ramesh", "email":"ramesh@gmail.com" }
Response:
{ "name": "Ramesh", "email": "ramesh@gmail.com", "_links": { "self": { "href": "http://localhost:8080/users/3" }, "user": { "href": "http://localhost:8080/users/3" } } } Bonus
What if you want to add a search feature? For example, let’s consider what you want to search by name. For this simply add the JPA method to the repository.
public User findByEmail(@Param(“email”) String email);
That’s it!!! We have just created search by email functionality.
Now to use this, we just need to hit the URL like below.
URL: http://localhost:8080/users/search/findByEmail?email=deep@gmail.com
Response:
{ "name" : "Deepak", "email" : "deep@gmail.com", "_links" : { "self" : { "href" : "http://localhost:8080/users/1" }, "user" : { "href" : "http://localhost:8080/users/1" } } }
If you notice, we haven’t written any controller for any endpoint. The Spring Data Rest did everything. Of course, if you want to create a complex rest endpoint, you can not go with Spring
Data Rest, but this will create a basic CRUD application and save a lot of time. You can explore more about Spring Data Rest here.
Also, you can find the source code on my GitHub profile.
How to Effectively Hire and Manage a Remote Team of Developers.
Download NowWe had very close go live timeline and MindBowser team got us live a month before.
CEO, BuyNow WorldWide
If you want a team of great developers, I recommend them for the next project.
Founder, Teach Reach
Mindbowser built both iOS and Android apps for Mindworks, that have stood the test of time. 5 years later they still function quite beautifully. Their team always met their objectives and I'm very happy with the end result. Thank you!
Founder, Mindworks
Our CISO was extremely impressed by Mindbowser’s work. It is pretty rare to see this kind of clean security report so early in the company’s journey. Huge Thank you for the disciplined approach here.
Founder, TrestleIQ
Mindbowser has delivered a much better quality product than our previous tech vendors. Our product is stable and passed Well Architected Framework Review from AWS.
CEO, PurpleAnt
The flexibility and capacity of the Mindbower staff has been impressive.
CEO, ProofPilot
I am happy to share that we got USD 10k in cloud credits courtesy of our friends at Mindbowser. Thank you Pravin and Ayush, this means a lot to us.
CTO, Shortlist
Mindbowser is one of the reasons that our app is successful. These guys have been a great team.
Founder & CEO, MangoMirror
Kudos for all your hard work and diligence on the Telehealth platform project. You made it possible.
CEO, ThriveHealth
Mindbowser helped us build an awesome iOS app to bring balance to people’s lives.
CEO, SMILINGMIND
They were a very responsive team! Extremely easy to communicate and work with!
Founder & CEO, TotTech
We’ve had very little-to-no hiccups at all—it’s been a really pleasurable experience.
Co-Founder, TEAM8s
Mindbowser was very helpful with explaining the development process and started quickly on the project.
Executive Director of Product Development, Innovation Lab
The greatest benefit we got from Mindbowser is the expertise. Their team has developed apps in all different industries with all types of social proofs.
Co-Founder, Vesica
Mindbowser is professional, efficient and thorough.
Consultant, XPRIZE
Very committed, they create beautiful apps and are very benevolent. They have brilliant Ideas.
Founder, S.T.A.R.S of Wellness
MindBowser was great; they listened to us a lot and helped us hone in on the actual idea of the app. They had put together fantastic wireframes for us.
Co-Founder, Flat Earth
Ayush was responsive and paired me with the best team member possible, to complete my complex vision and project. Could not be happier.
Founder, Child Life On Call
As a founder of a budding start-up, it has been a great experience working with Mindbower Inc under Ayush's leadership for our online digital platform design and development activity.
Founder, Courtyardly
The team from Mindbowser stayed on task, asked the right questions, and completed the required tasks in a timely fashion! Strong work team!
CEO, SDOH2Health LLC
Mindbowser was easy to work with and hit the ground running, immediately feeling like part of our team.
CEO, Stealth Startup
Mindbowser was an excellent partner in developing my fitness app. They were patient, attentive, & understood my business needs. The end product exceeded my expectations. Thrilled to share it globally.
Owner, Phalanx
Mindbowser's expertise in tech, process & mobile development made them our choice for our app. The team was dedicated to the process & delivered high-quality features on time. They also gave valuable industry advice. Highly recommend them for app development...
Co-Founder, Fox&Fork
We cannot express enough how pleased we are with the entire Mindbowser team. From our first call, they focused on our vision and ensured things were handled as per requirement. Communication was so easy and flexible to our schedule. I’m...
Founder, SafeZone Safety Systems