- It is a kind of Spring Boot example with covering important and useful features
- Here is the explanation of the example
- Admin and User implement their own authentication and authorization through their defined role name
- Admin handles with creating product, getting all products, getting product by Id, updating product by Id and lastly deleting product by Id
- Admin only handles with getting all products and getting product by Id
Method | Url | Description | Request Body | Header | Valid Path Variable | No Path Variable |
---|---|---|---|---|---|---|
POST | /api/v1/authentication/admin/register | Admin Register | AdminRegisterRequest | |||
POST | /api/v1/authentication/admin/login | Admin Login | LoginRequest | |||
POST | /api/v1/authentication/admin/refreshtoken | Admin Refresh Token | TokenRefreshRequest | |||
POST | /api/v1/authentication/admin/logout | Admin Logout | TokenInvalidateRequest | |||
POST | /api/v1/authentication/user/register | User Register | UserRegisterRequest | |||
POST | /api/v1/authentication/user/login | User Login | LoginRequest | |||
POST | /api/v1/authentication/user/refreshtoken | User Refresh Token | TokenRefreshRequest | |||
POST | /api/v1/authentication/user/logout | User Logout | TokenInvalidateRequest | |||
POST | /api/v1/products | Create Product | ProductCreateRequest | |||
GET | /api/v1/products/{productId} | Get Product By Id | ProductId | |||
GET | /api/v1/products | Get Products | ProductPagingRequest | |||
PUT | /api/v1/products/{productId} | Update Product By Id | ProductUpdateRequest | ProductId | ||
DELETE | /api/v1/products/{productId} | Delete Product By Id | ProductId | |||
- Java 17
- Spring Boot 3.0
- Restful API
- Lombok
- Maven
- Junit5
- Mockito
- Integration Tests
- Docker
- Docker Compose
DATABASE_USERNAME={DATABASE_USERNAME}
DATABASE_PASSWORD={DATABASE_PASSWORD}
- Maven or Docker
The application can be built and run by the Docker
engine. The Dockerfile
has multistage build, so you do not need to build and run separately.
Please follow directions shown below in order to build and run the application with Docker Compose file;
$ cd springbootsecurity
$ docker-compose up -d
If you change anything in the project and run it on Docker, you can also use this command shown below
$ cd springbootsecurity
$ docker-compose up --build
To build and run the application with Maven
, please follow the directions shown below;
$ cd springbootsecurity
$ mvn clean install
$ mvn spring-boot:run