Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/w-ptra/spring_boot_crud_api
A simple RESTful API built with Spring Boot application that performs Create, Read, Update, and Delete (CRUD) operation on a "Product" table in MySQL database using JDBC Driver.
https://github.com/w-ptra/spring_boot_crud_api
java jdbc-driver spring-boot
Last synced: 2 days ago
JSON representation
A simple RESTful API built with Spring Boot application that performs Create, Read, Update, and Delete (CRUD) operation on a "Product" table in MySQL database using JDBC Driver.
- Host: GitHub
- URL: https://github.com/w-ptra/spring_boot_crud_api
- Owner: W-ptra
- Created: 2024-06-23T13:24:30.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-06-27T12:17:11.000Z (7 months ago)
- Last Synced: 2024-11-25T04:09:01.193Z (2 months ago)
- Topics: java, jdbc-driver, spring-boot
- Language: Java
- Homepage:
- Size: 23.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Spring_Boot_CRUD_API
A simple RESTful API built with Spring Boot application that performs Create, Read, Update, and Delete (CRUD) operation on a "Product" table in MySQL database using JDBC Driver.
## API Endpoint
1. `GET http://localhost:8000/api/product`
Retrieve all product data from database
Respond:
```
[
{
"id": 1,
"name": "Almond",
"price": 24000
},
{
"id": 2,
"name": "Chocolate",
"price": 8000
}
]
```
2. `GET http://localhost:8000/api/product/2`
Retrieve a single product data identified by id 2
Respond:
```
[
{
"id": 2,
"name": "Chocolate",
"price": 8000
}
]
```
3. `POST http://localhost:8000/api/product`
Create a new product and store it on database
Request:
```
{
"name":"Blueberry",
"price":6000
}
```
Respond:
```
{
"message": "Product Created Sucessfully"
}
```
4. `PUT http://localhost:8000/api/product/2`
Make a update to specified product that identified by id 2
Request:
```
{
"name":"Gummy Bear",
"price":11000
}
```
Respond:
```
{
"message": "Product Updated Sucessfully"
}
```
5. `DELETE http://localhost:8000/api/product/2`
Delete a certain product on database identified by id 2
Respond:
```
{
"message": "Product Deleted Sucessfully"
}
```
## DOCKER USAGE
1. Pull image
```
docker pull wisnup001binus/spring-boot-crudapi:1.0
```
2. Run following command, change the environment variable `PORT`,`URL`,`USERNAME`,`PASSWORD`
```
docker run -d \
--name spring-boot-api \
--network spring_network \
-p 8080:3000 \
-e PORT:{port} \
-e URL={url} \
-e USERNAME={username} \
-e PASSWORD={password} \
wisnup001binus/spring-boot-crudapi:1.0
```
### Quick Setup
1. Run following script
```
docker network create spring_network
docker run -d \
--name mysql \
--network spring_network \
-p 7000:3306 \
wisnup001binus/mysql_product_table:1.0
docker network inspect spring_network
```
2. copy the ` "IPv4Address"` of `mysql`'s container, below is the example output
3. Paste it on `URL="jdbc:mysql://172.21.0.2:3306/my_db"` and run the script
```
docker run -d \
--name spring-boot-api \
--network spring_network \
-p 8080:3000 \
-e PORT=3000 \
-e URL="jdbc:mysql://172.21.0.2:3306/my_db" \
-e USERNAME="root" \
-e PASSWORD="root" \
wisnup001binus/spring-boot-crudapi:1.0
```
4. Open browser and paste following URL
```
http://localhost:8080/api/product
```
Note: Please wait around 2 - 3 minutes and refresh the page to see the product data
5. Clean Up
```
docker stop spring-boot-api mysql
docker remove spring-boot-api mysql
docker network remove spring_network
```