https://github.com/faranak-cs/spring-rest-app

REST app in Spring
https://github.com/faranak-cs/spring-rest-app

maven rest-api spring-boot

Last synced: 26 days ago
JSON representation

REST app in Spring

• Host: GitHub
• URL: https://github.com/faranak-cs/spring-rest-app
• Owner: faranak-cs
• Created: 2024-07-03T13:49:11.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-12-10T21:53:50.000Z (about 1 month ago)
• Last Synced: 2024-12-10T22:29:29.954Z (about 1 month ago)
• Language: Java
• Homepage:
• Size: 111 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Spring REST App

REST API in Spring to perform CRUD operations on a H2 in-memory database of Products.

## REST Endpoints

- `/actuator/health`

- `/createProduct`

- `/getAllProducts`

- `/getProductById/{id}`

- `/updateProductById/{id}`

- `/deleteProduct/{id}`

- `/swagger-ui/index.html`

## Requirements

### Controller

- Implement the REST endpoints described in the section below

- Create a “Product” DTO to be used by the REST API

- Implement Swagger for the API

- Implement appropriate validation on the endpoints. e.g. Returning a 400 Bad Request responses fields are missing when creating a product

### Service Layer

- Implement a service layer which should act as the intermediary between the Controller and Repository layers of the application

- Should map “Product” DTO to and from “Product” entity/model (Java object used by the repository layer)

### Repository Layer

- Create an in-memory H2 database for the system to store products

- Create a repository layer using Spring JPA

- Create a “Product” entity for the repository layer

- The “Product” entity should have a unique id field that is managed by Spring JPA using sequence generation

## Useful Links

- https://spring.io/guides/tutorials/rest

- https://www.baeldung.com/intro-to-project-lombok

- https://www.baeldung.com/swagger-2-documentation-for-spring-rest-api

- https://www.baeldung.com/spring-boot-h2-database

- https://spring.io/projects/spring-data-jpa

- https://www.baeldung.com/java-entity-vs-dto

- https://www.baeldung.com/spring-boot-logback-log4j2

- https://www.baeldung.com/exception-handling-for-rest-with-spring

- https://spring.io/guides/gs/testing-web

- https://www.oracle.com/ie/technical-resources/articles/java/javadoc-tool.html

- https://www.baeldung.com/spring-boot-actuators

## Architecture Diagram

![Arch-Diagram](https://github.com/faranak-cs/spring-rest-app/assets/73027299/7c718584-29fb-4908-a924-0f7566a342c4)

## Deployment



## Demo Video

https://github.com/faranak-cs/spring-rest-app/assets/73027299/0f4f37fe-4550-4ec4-a353-a2a28f69d8d9

## Version

| Library      | Version |

| -----------      | ----------- |

| IntelliJ IDEA CE | 2024.1.4    |

| Java             | 17.0.11-tem |

| Maven            | 3.9.8  |

| Spring Boot      | 3.3.1  |

| Spring Framework | 6.1.10 |