create the api contract for endpoints and model for users, and make entity, service, controller, repository, and mapper, validator, and password encryption. Also implemented the test. Code is commented!

Author: Csaba79-coder

api-contract/src/main/resources/api-contract.yaml

@@ -13,6 +13,7 @@ tags:
   - name: menu
   - name: index
   - name: log
+  - name: user
 
 paths:
   /:
@@ -310,7 +311,7 @@ paths:
     get:
       tags:
         - log
-      summary: Get all log
+      summary: Get all logs
       operationId: renderAllLogs
       responses:
         '200':
@@ -355,6 +356,120 @@ paths:
         '405':
           description: Invalid input
 
+  /api/admin/user-service/users:
+    get:
+      tags:
+        - user
+      summary: Get all Users
+      operationId: renderAllUsers
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                type: array
+                items:
+                  $ref: '#/components/schemas/UserModel'
+        '400':
+          description: Bad request
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: User not found
+        '405':
+          description: Validation exception
+
+    post:
+      tags:
+        - user
+      summary: Add new user in a service
+      description: Add new user in a service and save to database
+      operationId: addNewUser
+      requestBody:
+        description: Create a user and store it
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserNewModel'
+        required: true
+      responses:
+        '201':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserModel'
+        '405':
+          description: Invalid input
+
+  /api/admin/user-service/users/{userId}:
+    get:
+      tags:
+        - user
+      summary: Get user by Id
+      operationId: renderUserById
+      parameters:
+        - name: userId
+          in: path
+          description: ID of the user to update
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: '3a8ea9f1-1a95-4caf-932f-2f988052933b'
+      responses:
+        '200':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserModel'
+        '400':
+          description: Bad request
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: User not found
+        '405':
+          description: Validation exception
+
+    put:
+      tags:
+        - user
+      summary: Modify an existing user in a service
+      description: Modify an existing user in a service and save to database
+      operationId: modifyUserById
+      parameters:
+        - name: userId
+          in: path
+          description: ID of the user to update
+          required: true
+          schema:
+            type: string
+            format: uuid
+          example: '3a8ea9f1-1a95-4caf-932f-2f988052933b'
+      requestBody:
+        description: Create a user and store it
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/UserModel'
+        required: true
+      responses:
+        '201':
+          description: Successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/UserModifyModel'
+        '405':
+          description: Invalid input
+
 components:
   schemas:
     RepresentativeAdminModel:
@@ -589,4 +704,76 @@ components:
         level:
           type: string
         serviceName:
-          type: string
+          type: string
+
+    UserNewModel:
+      type: object
+      properties:
+        username:
+          type: string
+        password:
+          type: string
+        repeatPassword:
+          type: string
+        email:
+          type: string
+      required:
+        - username
+        - password
+        - repeatPassword
+        - email
+
+    UserModel:
+      type: object
+      properties:
+        id:
+          description: Id of the User
+          type: string
+          format: uuid
+          example: '3a8ea9f1-1a95-4caf-932f-2f988052933b'
+        createdAt:
+          description: Creation time of User entity
+          type: string
+          format: datetime
+          example: '2019-01-21T05:47:08.644'
+        updatedAt:
+          description: Updated time of User entity
+          type: string
+          format: datetime
+          example: '2019-01-21T05:47:08.644'
+        createdBy:
+          description: Admin id who created the User entity
+          type: string
+          format: uuid
+          example: '3a8ea9f1-1a95-4caf-932f-2f988052933b'
+        updatedBy:
+          description: User/Admin id who updated the User entity and with setting availability to DELETE, will achieve a soft delete
+          type: string
+          format: uuid
+          example: '3a8ea9f1-1a95-4caf-932f-2f988052933b'
+        username:
+          type: string
+        email:
+            type: string
+        role:
+          $ref: '#/components/schemas/Role'
+        availability:
+          $ref: '#/components/schemas/Availability'
+    UserModifyModel:
+      type: object
+      properties:
+        username:
+          type: string
+        email:
+          type: string
+        role:
+          $ref: '#/components/schemas/Role'
+        availability:
+          $ref: '#/components/schemas/Availability'
+
+    Role:
+      type: string
+      enum:
+        - ADMIN
+        - USER
+        - SUPER_ADMIN

api-gateway/src/main/resources/application.properties

@@ -34,4 +34,7 @@ spring.cloud.gateway.routes[3].id=logging-service
 spring.cloud.gateway.routes[3].uri=lb://logging-service
 spring.cloud.gateway.routes[3].predicates[0]=Path=/api/admin/logging-service/**
 
-
+# User Service Route:
+spring.cloud.gateway.routes[4].id=user-service
+spring.cloud.gateway.routes[4].uri=lb://user-service
+spring.cloud.gateway.routes[4].predicates[0]=Path=/api/admin/user-service/**

pom.xml

@@ -30,7 +30,7 @@
         <maven.compiler.target>17</maven.compiler.target>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
         <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
-        <project.version>3.0.0-SNAPSHOT</project.version>
+        <project.version>3.2.0-SNAPSHOT</project.version>
         <spring-cloud.version>2022.0.2</spring-cloud.version>
     </properties>
 

user-service/pom.xml

@@ -79,6 +79,18 @@
             <artifactId>h2</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>com.csaba79coder</groupId>
+            <artifactId>api-contract</artifactId>
+            <version>3.0.2</version>
+            <scope>compile</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.glassfish.hk2.external</groupId>
+            <artifactId>aopalliance-repackaged</artifactId>
+            <version>3.0.3</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
 </project>

user-service/src/main/java/com/csaba79coder/userservice/UserServiceApplication.java

@@ -4,10 +4,35 @@
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.client.discovery.EnableDiscoveryClient;
 
+/**
+ * This is the main class for the User Service application. It is
+ * annotated with @SpringBootApplication, which is a convenience
+ * annotation that combines three other annotations:
+ * - @Configuration: indicates that this class provides configuration
+ *   information for the application context.
+ * - @EnableAutoConfiguration: enables Spring Boot's autoconfiguration
+ *   feature, which automatically configures the application based on
+ *   classpath settings, other beans, and various property settings.
+ * - @ComponentScan: tells Spring to scan this package and its
+ *   sub-packages for components (i.e., beans) that can be autowired
+ *   into other beans.
+ *
+ * Additionally, this class is annotated with @EnableDiscoveryClient,
+ * which enables it to register with a service registry (such as Eureka)
+ * as a discovery client. This allows other services to discover and
+ * communicate with this service.
+ */
 @SpringBootApplication
 @EnableDiscoveryClient // added @EnableDiscoveryClient for this to work as a discovery client
 public class UserServiceApplication {
 
+    /**
+     * This is the main method for the User Service application. It
+     * starts the Spring application context and launches the
+     * application.
+     *
+     * @param args command-line arguments passed to the application
+     */
     public static void main(String[] args) {
         SpringApplication.run(UserServiceApplication.class, args);
     }

user-service/src/main/java/com/csaba79coder/userservice/controller/UserController.java

@@ -0,0 +1,62 @@
+package com.csaba79coder.userservice.controller;
+
+import com.csaba79coder.bestprotocol.api.UserApi;
+import com.csaba79coder.bestprotocol.model.UserModel;
+import com.csaba79coder.bestprotocol.model.UserModifyModel;
+import com.csaba79coder.bestprotocol.model.UserNewModel;
+import com.csaba79coder.userservice.model.service.UserService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RestController;
+
+import java.util.List;
+import java.util.UUID;
+
+/**
+ * responsible for the endpoints
+ */
+@RestController
+@RequiredArgsConstructor
+public class UserController implements UserApi {
+
+    private final UserService userService;
+
+    /**
+     * responsible for the endpoints
+     * @return the user model
+     * @param body the user model
+     */
+    @Override
+    public ResponseEntity<UserModel> addNewUser(UserNewModel body) {
+        return ResponseEntity.status(201).body(userService.addNewUser(body));
+    }
+
+    /**
+     * responsible for the endpoints
+     * @param userId the user id
+     * @return the user modify model
+     */
+    @Override
+    public ResponseEntity<UserModifyModel> modifyUserById(UUID userId, UserModel body) {
+        return ResponseEntity.status(200).body(userService.modifyUserById(userId, body));
+    }
+
+    /**
+     * responsible for the endpoints
+     * @return the user model
+     */
+    @Override
+    public ResponseEntity<List<UserModel>> renderAllUsers() {
+        return ResponseEntity.status(200).body(userService.renderAllUsers());
+    }
+
+    /**
+     * responsible for the endpoints
+     * @param userId
+     * @return the user model
+     */
+    @Override
+    public ResponseEntity<UserModel> renderUserById(UUID userId) {
+        return ResponseEntity.status(200).body(userService.renderUserById(userId));
+    }
+}

user-service/src/main/java/com/csaba79coder/userservice/model/base/entity/Auditable.java

@@ -0,0 +1,37 @@
+package com.csaba79coder.userservice.model.base.entity;
+
+import jakarta.persistence.Column;
+import jakarta.persistence.MappedSuperclass;
+import lombok.Getter;
+import lombok.Setter;
+import org.hibernate.annotations.CreationTimestamp;
+
+import java.time.LocalDateTime;
+import java.util.UUID;
+
+/**
+ * A base class for entities that need to be audited. This class provides the common audit fields such as created_at,
+ * updated_at, created_by and updated_by.
+ *
+ * This class is annotated with @MappedSuperclass which means that the properties of this class will be mapped to the
+ * properties of its subclasses.
+ */
+@MappedSuperclass
+@Getter
+@Setter
+public class Auditable extends Identifier {
+
+    @CreationTimestamp
+    @Column(name = "created_at", nullable = false)
+    private LocalDateTime createdAt = LocalDateTime.now();
+
+    @CreationTimestamp
+    @Column(name = "updated_at", nullable = false)
+    private LocalDateTime updatedAt = LocalDateTime.now();
+
+    @Column(name = "created_by")
+    private UUID createdBy = UUID.fromString("6772c9dc-a7be-4826-963a-e376074fd4e7");
+
+    @Column(name = "updated_by")
+    private UUID updatedBy = UUID.fromString("dbd58012-9ee7-47d5-8f87-9bbc91583009");
+}