This is a simple game rental service API that I created using Spring Boot. The purpose of this project was to test my knowledge of this framework and to learn how to use its features. The API allows users to create, update, delete and search for games, as well as to rent and return them. It also handles authentication and authorization using JWT tokens. The API follows the RESTful principles and uses a PostgreSQL container as its database. I used Spring Boot Starter Web, Spring Boot Starter Data JPA, Spring Boot Starter Security and Spring Boot Starter Test as dependencies. I also used Lombok to reduce boilerplate code and Swagger to document the API. The project is available on GitHub and can be run using Maven or Docker.
| Feature | Status |
|---|---|
| Consistent API design | 🟢 Ready |
| Use of DTOs | 🟢 Ready |
| Use of HATEOAS | 🟢 Ready |
| Spring Security with JWT | 🟢 Ready |
| User authentication and email verification | 🟢 Ready |
| Caching with Redis | 🟡 In development |
| Documentation with SwaggerUI and Javadocs | 🟢 Ready |
| Pagination and sorting | 🟢 Ready |
| Mailing service with JavaMail | 🟢 Ready |
| Data generation with JavaFaker | 🟢 Ready |
| Layered architecture | 🟢 Ready |
| Global Error Handling | 🟢 Ready |
| API versioning | 🟢 Ready |
| Excel, CSV and PDF exporting | 🟢 Ready |
| File upload and download | 🟡 In development |
| Logging with Log4j2 | 🟢 Ready |
| CI/ CD with Docker and Railway | 🟢 Ready |
This layer is at the top of the architecture. This tier is responsible for:
✔️ Performing authentication.
✔️ Converting JSON data into an object (and vice versa).
✔️ Handling HTTP requests.
✔️ Transfering authentication to the business layer.
The business layer is responsible for:
✔️ Performing validation.
✔️ Performing authorization.
✔️ Handling the business logic and rules.
This layer is responsible for:
✔️ Containing storage logic.
✔️ Fetching objects and translating them into database rows (and vice versa).
This layer is simply the actual database that is responsible for:
✔️ Performing database operations (mainly CRUD operations).
- Clone the repository
- Navigate to the project directory
- Build the project using Maven:
./mvnw clean package -DskipTests
- Run the project using Maven wrapper:
./mvnw spring-boot:run
-
The application will start on http://localhost:8080
-
You can then test the API using Swagger UI or some HTTP client like curl or Postman
- You will also need the database installed on your machine and set the connection vars on the application.properties or application.yml