Loading repository data…
elenamountz / repository
A RESTful API using Spring Boot, Maven, Hibernate, MySQL, Spring Data JPA, Flyway and Querydsl.
This project built using Java and the following tools:
Domain model is organized under the model package and it consists of entity classes. Entities use various annotations that describe the relationships between each other. All these annotations are used by JPA in order to map entities to database tables.
DTO stands for Data Transfer Object and I definitely choose to use DTOs, in order to decouple the model layer from the client side. There are many approaches on this topic, but in my opinion the cleanest one is to transfer only the needed data using DTO, instead of populating the entire model. For small projects (like this), it is common for a DTO to be identical with the corresponding model. In this situation, I don't skip this conversion (entity to DTO and vice versa), in order to implement a more scalable application. In short, DTOs represent the incoming and the outgoing data that our applications handle. For applications with larger business logic, it is possible to create two or more separate DTOs (e.g. request and response data representation).
Repositories are interfaces that are responsible for data persistence and retrieval. The repository layer is an abstraction that provides all CRUD functionality and keeps hidden the data related information (e.g. specific database implmentation) from the other layers. This layer should always persist entities.
Service layer depends on the repository layer and provides separation of concern, encapsulating all the business logic implementation. It is there to apply business rules on data sent to and from the repository layer. Service layer does not care about the specific database implementation and provides loose coupling. This technique makes the application super flexible in a possible data source replacement. This layer should always receive and return DTOs.
Controller layer depends on the service layer and is responsible for the incoming requests and the outgoing responses. A controller determines all the available endpoints that client side (or other api) is able to call. This layer should not apply logic on the receiving or returning data.
CREATE DATABASE warehouse;
In case you want to use a different database name, follow the next steps:
CREATE DATABASE DB_NAME;
src/main/resources/application.properties filedb.name property to match your preferred database name DB_NAMEsrc/main/resources/application.properties filespring.datasource.username and spring.datasource.password properties to match your MySQL connectionBuild the application using the following maven wrapper command:
./mvnw clean package
In case you want to use this project as a dependency in other projects locally, use the following command:
./mvnw clean install
Each of these commands will create an executable .jar file at target directory.
After packaging the application into an executable .jar file, you can start the server running the following command using any terminal in the project directory:
java -jar target/warehouse-0.0.1.jar
Alternatively, you can start the server without packaging, by running the following command:
./mvnw spring-boot:run
The server will start running at http://localhost:8080.
Every time the server is running, it triggers the flyway migration tool to look for possible schema changes. The first time, flyway will create a table called
schema_version, in order to write down all the scripts have already run, in a versioning way. Additionally, it will run all the available scripts at
src/main/resources/db/mysql/ directory.
After the first run, flyway will detect and run only the new scripts.
When server is up and running, you can use swagger to explore the available endpoints and try them out. Find it at: http://localhost:8080/wh/swagger-ui.html#/
This project is licensed under the terms of the MIT license. Check LICENSE file.
Selected from shared topics, language and repository description—not editorial ratings.
vishalbansal28 /
A RESTful API using Spring Boot, Maven, Hibernate, MySQL, Spring Data JPA, Flyway and Querydsl.