Spring Boot framework of a restful application for an advertisement system, which receives the advertisement information and creates an advertisement record. I chose all the choices in the project, the most appropriate ones according to the case study.
-
Microservice Architecture
-
Clean Code
-
N-layer Architecture
-
SOLID
-
REST Convention
-
Exception handle
-
Data JPA/Hibernate
-
Exception handle
-
Postman Test
-
Containerization with Docker
-
Code Quality and Code Security Sonarlint
-
Features
- Documentation with Swagger -> Actually I did, but the library doesn't support 2.7.0+ so it doesn't work actively, but I made its impamentation.
- Unit Test and Integration Test
- Testing with Code Coverage > 80%
- Manuel
# if local run in the microservice directory you want to run
$ mvn clean install
# withouth test
$ mvn clean install -DskipTests
# if want to run manuel docker
# build
$ mvn dockerfile:build
# run example
# If you want to start it manually, I suggest you look at the envirments of the relevant service in the docker-compose file.
$ docker run -it --rm -p 8081:8080 --name report report-service- Automatic
# if you want open detached mode(-d)
$ docker-compose up-
Advert-ServiceGET /api/v1/adverts/{id}
// Response payload { "id" : 1, "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "createdAt":"new Date()", "updatedAt":"new Date()", "price":"12345", "views":0 }
GET /api/v1/adverts
// Response payload [ { "id" : 1, "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "createdAt":"new Date()", "updatedAt":"new Date()", "price":"12345", "views":0 }, . . ]
POST /api/v1/adverts
// Request payload { "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "price":"12345", }
GET /api/v1/adverts/manage/rejects
// Response payload - hasAnyAuthority -> Admin [ { "id" : 1, "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "createdAt":"new Date()", "updatedAt":"new Date()", "price":"12345", "views":0 }, . . ]
PATCH /api/v1/adverts/manage/{id}/approve
// Response payload { "id" : 1, "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "createdAt":"new Date()", "updatedAt":"new Date()", "price":"12345", "views":0 }
PATCH /api/v1/adverts/manage/{id}/disapprove
// Response payload { "id" : 1, "title":"test", "information":"test", "description":"test", "password":"test", "location":"test", "createdAt":"new Date()", "updatedAt":"new Date()", "price":"12345", "views":0 }
-
Auth-ServicePOST /login
// Request payload - x-www-from-system { "username":"", "password":1234 }
// Response payload { "refresh_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInJvbGVzIjpbIkFETUlOIl0sImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MS9sb2dpbiIsImV4cCI6MTY1ODIwMTA5NH0.3gcuR1j1SwIdlx0mcDPHhWJZH3Lyn96H5zSa368p3R4", "access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJhZG1pbiIsInJvbGVzIjpbIkFETUlOIl0sImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODA4MS9sb2dpbiIsImV4cCI6MTY1ODIwMTA5NH0.3gcuR1j1SwIdlx0mcDPHhWJZH3Lyn96H5zSa368p3R4" }
POST /api/v1/register
// Request payload { "name":"aaa", "surname":"test", "username":"test", "password":"test", "phoneNumber":"test", "email":"[email protected]" }
// Response payload { "id": 1, "name":"aaa", "surname":"test", "username":"test", "password":"test", "phoneNumber":"test", "email":"[email protected]", "role": "ADMIN" }
GET /api/v1/users
// Request payload - hasAnyAuthority -> Admin { "username":"", "password":1234 }
// Response payload [ { "id": 1, "name":"aaa", "surname":"test", "username":"test", "password":"test", "phoneNumber":"test", "email":"[email protected]", "role": "ADMIN" }, . . ]
GET /api/v1/token/{token}
// Response payload { "username":"test", "role": "ADMIN" }
-
Report-ServiceGET /api/v1/report/{id}
// Response payload - hasAnyAuthority -> Admin { "id":1, "username": "test", "createdAt":"new Date()", "views":1 }
PUT /api/v1/report/{id}
// Response payload - hasAnyAuthority -> Admin { "username": "test", "createdAt":"new Date()", "views":1 }
// Response payload { "id":1, "username": "test", "createdAt":"new Date()", "views":1 }
I gathered the microservice architecture under a single repo.
.
├── advert-service
│ ├── advert-service.iml
│ ├── Dockerfile
│ ├── HELP.md
│ ├── mvnw
│ ├── mvnw.cmd
│ ├── pom.xml
│ └── src
│ ├── main
│ │ ├── java
│ │ │ └── com
│ │ │ └── example
│ │ │ └── advertservice
│ │ │ ├── AdvertServiceApplication.java
│ │ │ ├── configuration
│ │ │ │ ├── RabbitMQConfiguration.java
│ │ │ │ └── SwaggerDocumentConfiguration.java
│ │ │ ├── controller
│ │ │ │ └── AdvertController.java
│ │ │ ├── dto
│ │ │ │ ├── AdvertCreateDTO.java
│ │ │ │ ├── AdvertSendProducerDTO.java
│ │ │ │ ├── AdvertUpdateDTO.java
│ │ │ │ ├── AdvertViewDTO.java
│ │ │ │ └── AdvertViewForAdminDTO.java
│ │ │ ├── exception
│ │ │ │ ├── ErrorHandler.java
│ │ │ │ └── NotFoundException.java
│ │ │ ├── mapper
│ │ │ │ └── AdvertModelMapper.java
│ │ │ ├── model
│ │ │ │ ├── Advert.java
│ │ │ │ └── UsernameAndRole.java
│ │ │ ├── producer
│ │ │ │ └── AdvertProducer.java
│ │ │ ├── repository
│ │ │ │ └── AdvertRepository.java
│ │ │ ├── security
│ │ │ │ ├── HttpConfigurer.java
│ │ │ │ ├── JwtAuthenticationFilter.java
│ │ │ │ ├── JwtAuthorizationFilter.java
│ │ │ │ └── SecurityConfig.java
│ │ │ └── service
│ │ │ ├── AdvertServiceImpl.java
│ │ │ └── AdvertService.java
│ │ └── resources
│ │ └── application.yml
│ └── test
│ └── java
│ └── com
│ └── example
│ └── advertservice
│ └── AdvertServiceApplicationTests.java
├── assets
│ ├── design
│ │ └── emlakJet.excalidraw
│ ├── img
│ │ ├── system-design.png
│ │ └── system-design.svg
│ └── pdf
│ └── project.pdf
├── auth-service
│ ├── auth-service.iml
│ ├── Dockerfile
│ ├── mvnw
│ ├── mvnw.cmd
│ ├── pom.xml
│ ├── src
│ │ ├── main
│ │ │ ├── java
│ │ │ │ └── com
│ │ │ │ └── example
│ │ │ │ └── authservice
│ │ │ │ ├── AuthServiceApplication.java
│ │ │ │ ├── configuration
│ │ │ │ │ └── SwaggerDocumentConfiguration.java
│ │ │ │ ├── controllers
│ │ │ │ │ ├── SecurityController.java
│ │ │ │ │ └── UserController.java
│ │ │ │ ├── dto
│ │ │ │ │ ├── AddRoleRequestDTO.java
│ │ │ │ │ ├── CreateUserRequestModel.java
│ │ │ │ │ ├── ResponseModel.java
│ │ │ │ │ └── UserResponseModel.java
│ │ │ │ ├── error
│ │ │ │ │ ├── ErrorHandler.java
│ │ │ │ │ └── NotFoundException.java
│ │ │ │ ├── mapper
│ │ │ │ │ └── UserModelMapper.java
│ │ │ │ ├── models
│ │ │ │ │ ├── Role.java
│ │ │ │ │ ├── User.java
│ │ │ │ │ └── UsernameAndRole.java
│ │ │ │ ├── repositories
│ │ │ │ │ └── UserRepository.java
│ │ │ │ ├── security
│ │ │ │ │ ├── HttpConfigurer.java
│ │ │ │ │ ├── JwtAuthenticationFilter.java
│ │ │ │ │ ├── JwtAuthorizationFilter.java
│ │ │ │ │ ├── JwtUtil.java
│ │ │ │ │ └── SecurityConfig.java
│ │ │ │ └── services
│ │ │ │ ├── UserServiceImpl.java
│ │ │ │ └── UserService.java
│ │ │ └── resources
│ │ │ └── application.yml
│ │ └── test
│ │ └── java
│ │ └── com
│ │ └── example
│ │ └── authservice
│ │ ├── AuthServiceApplicationTests.java
│ │ └── services
│ │ └── UserServiceImplTest.java
│ └── test.http
├── docker-compose.yml
├── LICENSE
├── README.md
└── report-service
├── Dockerfile
├── HELP.md
├── mvnw
├── mvnw.cmd
├── pom.xml
├── report-service.iml
├── request.http
└── src
├── main
│ ├── java
│ │ └── com
│ │ └── example
│ │ └── reportservice
│ │ ├── configuration
│ │ │ ├── RabbitMQConfiguration.java
│ │ │ └── SwaggerDocumentConfiguration.java
│ │ ├── consumer
│ │ │ └── ReportConsumer.java
│ │ ├── controller
│ │ │ └── ReportController.java
│ │ ├── dto
│ │ │ ├── ConsumerReceiveMessageDTO.java
│ │ │ ├── ReportCreateDTO.java
│ │ │ ├── ReportUpdateDTO.java
│ │ │ └── ReportViewDTO.java
│ │ ├── exception
│ │ │ ├── ErrorHandler.java
│ │ │ └── NotFoundException.java
│ │ ├── mapper
│ │ │ └── ReportModelMapper.java
│ │ ├── model
│ │ │ ├── Report.java
│ │ │ └── UsernameAndRole.java
│ │ ├── ReportServiceApplication.java
│ │ ├── repository
│ │ │ └── ReportRepository.java
│ │ ├── security
│ │ │ ├── HttpConfigurer.java
│ │ │ ├── JwtAuthenticationFilter.java
│ │ │ ├── JwtAuthorizationFilter.java
│ │ │ └── SecurityConfig.java
│ │ └── service
│ │ ├── ReportServiceImpl.java
│ │ └── ReportService.java
│ └── resources
│ └── application.yml
└── test
└── java
└── com
└── example
└── reportservice
└── ReportServiceApplicationTests.java
-
PR's are welcome !
-
Found a Bug ? Create an Issue.
-
Do you want to give feedback? Create an Issue.
Leave a star If you think this project is cool.