https://github.com/beemi/book-service
Java REST API service with Spring boot framework
https://github.com/beemi/book-service
Last synced: 10 months ago
JSON representation
Java REST API service with Spring boot framework
- Host: GitHub
- URL: https://github.com/beemi/book-service
- Owner: beemi
- Created: 2024-01-21T04:28:58.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-01-23T02:25:11.000Z (over 2 years ago)
- Last Synced: 2024-01-23T07:23:53.661Z (over 2 years ago)
- Language: Java
- Homepage:
- Size: 403 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 📚 Spring Boot Book Service
## 📝 Description
This is a simple Spring Boot application that exposes a REST API to manage a book library. It's a great starting point for learning about Spring Boot, REST APIs, and database integration.
## 📋 Requirements
- ☕ Java 17
- 🏗️ Maven
- 🐳 Docker
- 🧩 Docker-compose
- 📬 Postman
## 🚀 How to Run
### ▶️ Run the Application Locally
To run the application directly on your machine, use the following Maven command:
```shell
mvn spring-boot:run
```
Create jar file
```shell
mvn clean package -DskipTests
```
### 🐳 Run the Application with Docker-compose
This application uses MySQL as the backend database. To run the application along with MySQL in Docker containers, use the following command:
```shell
docker-compose up -d
```
## 📖 Swagger API Documentation
🔍 Access the OpenAPI documentation to explore and test the API endpoints:
- Swagger UI: [http://localhost:8090/swagger-ui/index.html](http://localhost:8090/swagger-ui/index.html)
- API Docs in JSON format: [http://localhost:8090/v3/api-docs](http://localhost:8090/v3/api-docs)
