Scribd
Upload
10 views2 pages

Spring Boot REST API Development Guide

This document outlines the steps to create a Spring Boot REST application for blog management and food delivery services using JDK 21, Spring Boot 3.x, and various dependencies. It includes instructions for setting up the development environment, creating the backend, implementing CRUD operations, and integrating Swagger for API documentation. Additionally, it provides steps for running a React frontend application connected to the backend.

Uploaded by

21113002
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd
10 views2 pages

Spring Boot REST API Development Guide

This document outlines the steps to create a Spring Boot REST application for blog management and food delivery services using JDK 21, Spring Boot 3.x, and various dependencies. It includes instructions for setting up the development environment, creating the backend, implementing CRUD operations, and integrating Swagger for API documentation. Additionally, it provides steps for running a React frontend application connected to the backend.

Uploaded by

21113002
Copyright
© All Rights Reserved
We take content rights seriously. If you suspect this is your content, claim it here.
Available Formats
Download as TXT, PDF, TXT or read online on Scribd

Spring Boot REST Steps

Enter Spring boot REST


Understand RESTful web services n it's architecture , which sits on the top of
Spring MVC
(Draw a comparison , with existing Spring MVC Flow Diagram)
1.1 Ref : Full Stack [Link]

1.2 refer to : REST Simplified


1.3 Diag : web app vs web service
1.4 Readme : RestController vs MVC Controller n [Link]
1.5 Develop the backend for Blog management for category resource
(CRUD)

Tech Stack
JDK 21 , Embedded Tomcat 10.1 , Jakarta EE 9/10 , Spring Boot 3.x
IDE - STS 4

1. Launch STS 4 - new workspace


2. Window- preferences - JRE - Add JDK 21

Steps
1. Create spring boot app : using spring boot starter project (choose packaging as
JAR)
2. Use same spring boot starters as earlier.
Spring web , Mysql driver , Spring data JPA , Lombok , Spring Dev
Tools,validation,actuator

3. NO additional dependencies for view layer(i.e no jstl n no tomcat-embeded jasper


dependencies , in [Link]

4. Copy [Link] from earlier spring boot project


(Do not add view resolver related properties)

5. Later Add additional dependencies , in [Link]


<!--swagger dependency for Spring Boot 3 -->
<dependency>
<groupId>[Link]</groupId>
<artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
<version>2.8.6</version>
</dependency>
<!-- [Link] -->
<dependency>
<groupId>[Link]</groupId>
<artifactId>modelmapper</artifactId>
<version>3.2.3</version>
</dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.19.0</version>
</dependency>
<dependency>
<groupId>[Link]</groupId>
<artifactId>commons-lang3</artifactId>
<!-- <version>3.14.0</version> -->
</dependency>

OR
If you don't want to invest time in all of above , simply import "template
projects\spring_boot_backend_template" n start with the actual development .

6. Write simple RestController to serve simple resource , to confirm.

7. Build the layers in bottoms up manner, for the following objectives.

Objective : Complete backend for the Food Delivery App , for Restaurant Resource

Solve

1. Get All Restaurants


Use ResponseEntity
2. Add new Category

3. Delete catgeory details


3.1 Instead of a hard delete , add soft delete
3.2 Better design practice : Instead of returning a plain string message to the
front end , wrap it in the java object (ApiResponse:DTO) n then send it to front
end

4. Update category details


4.1 Get existing category details By Id(from the back end) : GET
4.2 Update category details : PUT

8.
Regarding swagger
Refer - "day16_help\Regarding [Link]"

Test it with postman/swagger (Add swagger dependency here)


Steps
1. Add swagger dependency in [Link]
(Already added in spring boot backend template project)
2. From web browser , access swagger endpoint
[Link]

Steps for running React App


0. Download & install node
[Link]

1. cd "day16-data\day16_help\React Front End\restaurants-frontend"

2. npm install

3. To run the react app on dev server


npm run dev

You might also like