This guide will help you understand the REST API projects with code examples on Github. We have a number of articles explaining these projects. These code examples will help beginners and experts to learn and gain expertise at developing RESTful Services with Spring Boot.
Spring Boot REST API Projects - Code Examples on Github
Let’s look at the articles in the following sections
- Projects Creating Basic REST API
- Adding Unit and Integration Tests to RESTful Services
- Securing RESTful Services
- Basic RESTful Service Features
- Advanced RESTful Service Features
Projects Creating Basic REST API
We explore couple of options of create RESTful Services with Spring Boot
- Using Spring Boot Web Starter
- Using Spring Data REST Starter
Using Spring Boot Web Starter, we have articles with
- An article focusing on basics of a REST Service
- A project exposing an end to end CRUD API for an entire Resource. The project uses JPA (Hibernate) to connect to a H2 in memory database.
| Title | Category | URL | Github |
|---|---|---|---|
| Creating REST Service with Spring Boot | REST API | URL | Project Code on Github |
| Introduction to Spring Data Rest - Create RESTful APIs at F1 Speed | Spring Data | URL | Project Code on Github |
| Creating a CRUD REST API/Service with Spring Boot, JPA and Hibernate | REST API | URL | Project Code on Github |
Adding Unit and Integration Tests to RESTful Services
Automation Tests (including Unit and Integration Tests) are a key part of ensuring your services and APIs evolve over a time period.
Let’s consider a StudentController which depends on StudentService.
In the unit test
- We will mock out the StudentService using Mockito
- We will use Mock MVC framework to launch only StudentController.
A key part of unit testing is to restrict the scope to a minimum. In this unit test, we want to test only the methods in
StudentController.
In the integration test
- We will launch the complete Spring Boot application using
@SpringBootTest - We will invoke the service methods using
TestRestTemplate - We will assert the results using a great JSON assert framework -
org.skyscreamer.jsonassert.JSONAssert
A key part of integration testing is testing all the layers in the application.
| Title | Category | URL | Github |
|---|---|---|---|
| Unit Testing Rest Services with Spring Boot and JUnit | REST API | URL | Project Code on Github |
| Writing Integration Tests for Rest Services with Spring Boot | REST API | URL | Project Code on Github |
| Spring Boot - Unit Testing and Mocking with Mockito and JUnit | Spring Boot Unit Testing | URL | Project Code on Github |
Securing RESTful Services
In the article below, we implement basic security for a REST API.
| Title | Category | URL | Github |
|---|---|---|---|
| Secure Rest Services and Web Applications with Spring Boot Security Starter | Spring Boot Basics | URL | Project Code on Github |
Basic RESTful Service Features
Great REST APIs have
- Awesome Exception Handling - You would want to return the right response with the exact response status based on the situation.
- Proper Validation - You would want to validate the right stuff and return a message which helps the consumer understand what failed.
- Current Documentation - A Consumer need to understand how to use your API. Great documentation makes your consumer and your job easy.
Articles below explore these features in depth.
| Title | Category | URL | Github |
|---|---|---|---|
| Spring Boot Exception(Error) Handling for RESTful Services | REST API | URL | Project Code on Github |
| Implementing Validation for RESTful Services with Spring Boot | REST API | URL | Project Code on Github |
| Spring Boot and Swagger - Documenting RESTful Services | REST API | URL | Project Code on Github |
REST API Advanced Features
At the next level, REST APIs have
- HATEOAS - HATEOAS stands for “Hypermedia as the engine of application state”. When some details of a resource are requested, you will provide the resource details as well as details of related resources and the possible actions you can perform on the resource. For example, when requesting information about a facebook user, a REST service can return the following
- user details
- Links to get his recent posts
- Links to get his recent comments
- Links to retrieve his friend’s list.
- Content Negotiation - Why should JSON be the only data exchange format to be supported? What if your consumer loves (or is stuck with) XML? Content Negotiation helps you support multiple data exchange formats for your RESTful API.
- Versioning - As your API evolves with your and your consumer needs, you would have the need to have multiple versions of the same Resource API. How do you handle that?
Articles below explore these features in depth.
| Spring Boot - HATEOAS for RESTful Services | REST API | URL | Project Code on Github |
| Spring Boot and Content Negotiation - XML and JSON Representations | REST API | URL | Project Code on Github |
| Versioning RESTful Services | REST API | URL | Project Code on Github |
Just Released
