IL-69 Add OpenAPI for User RestApi

pom.xml

@@ -320,17 +320,32 @@
                 <version>${openapi-generator-maven-plugin.version}</version>
                 <executions>
                     <execution>
+                        <id>generate-from-product-openapi-spec</id>
                         <goals>
                             <goal>generate</goal>
                         </goals>
                         <configuration>
                             <inputSpec>${project.basedir}/src/main/resources/api-specs/product-openapi.yaml</inputSpec>
                             <generatorName>spring</generatorName>
-                            <apiPackage>com.zufar.onlinestore.openapi.api</apiPackage>
+                            <apiPackage>com.zufar.onlinestore.openapi.product.api</apiPackage>
                             <modelPackage>com.zufar.onlinestore.product.dto</modelPackage>
-                            <supportingFilesToGenerate>
-                                ApiUtil.java
-                            </supportingFilesToGenerate>
+                            <generateModels>false</generateModels>
+                            <configOptions>
+                                <interfaceOnly>true</interfaceOnly>
+                                <useTags>true</useTags>
+                            </configOptions>
+                        </configuration>
+                    </execution>
+                    <execution>
+                        <id>generate-from-user-openapi-spec</id>
+                        <goals>
+                            <goal>generate</goal>
+                        </goals>
+                        <configuration>
+                            <inputSpec>${project.basedir}/src/main/resources/api-specs/user-openapi.yaml</inputSpec>
+                            <generatorName>spring</generatorName>
+                            <apiPackage>com.zufar.onlinestore.openapi.user.api</apiPackage>
+                            <modelPackage>com.zufar.onlinestore.user.dto</modelPackage>
                             <generateModels>false</generateModels>
                             <configOptions>
                                 <interfaceOnly>true</interfaceOnly>

src/main/java/com/zufar/onlinestore/product/endpoint/ProductsEndpoint.java

@@ -1,6 +1,6 @@
 package com.zufar.onlinestore.product.endpoint;
 
-import com.zufar.onlinestore.openapi.api.ProductsApi;
+import com.zufar.onlinestore.openapi.product.api.ProductsApi;
 import com.zufar.onlinestore.product.api.ProductApi;
 import com.zufar.onlinestore.product.dto.ProductInfoDto;
 import com.zufar.onlinestore.product.dto.ProductListWithPaginationInfoDto;

src/main/java/com/zufar/onlinestore/user/endpoint/UserEndpoint.java

@@ -1,5 +1,6 @@
 package com.zufar.onlinestore.user.endpoint;
 
+import com.zufar.onlinestore.openapi.user.api.UsersApi;
 import com.zufar.onlinestore.user.api.UserApi;
 import com.zufar.onlinestore.user.dto.UserDto;
 import lombok.RequiredArgsConstructor;
@@ -19,12 +20,13 @@
 @RequiredArgsConstructor
 @Validated
 @RequestMapping(value = UserEndpoint.API_CUSTOMERS)
-public class UserEndpoint {
+public class UserEndpoint implements UsersApi {
 
     public static final String API_CUSTOMERS = "/api/v1/users";
 
     private final UserApi userApi;
 
+    @Override
     @GetMapping("/{userId}")
     public ResponseEntity<UserDto> getUserById(@PathVariable final String userId) {
         log.info("Received the request to get the User with userId - {}.", userId);

src/main/resources/api-specs/user-openapi.yaml

@@ -0,0 +1,64 @@
+openapi: "3.0.3"
+
+info:
+  title: "Online-Store API"
+  version: "1.0.0"
+
+servers:
+  - url: "http://localhost:8083"
+
+tags:
+  - name: "Users"
+    description: "An API for getting user information"
+
+paths:
+  /api/v1/users/{userId}:
+    get:
+      tags:
+        - "Users"
+      summary: "Enables to get a user by its id"
+      operationId: "getUserById"
+      parameters:
+        - name: "userId"
+          description: "the identifier of the user which is returned as the return value"
+          in: "path"
+          required: true
+          schema:
+            type: "string"
+      responses:
+        "200":
+          description: "OK"
+          content:
+            '*/*':
+              schema:
+                $ref: "#/components/schemas/UserDto"
+
+components:
+  schemas:
+    AddressDto:
+      type: "object"
+      properties:
+        line:
+          type: "string"
+        city:
+          type: "string"
+        country:
+          type: "string"
+
+    UserDto:
+      type: "object"
+      properties:
+        firstName:
+          type: "string"
+        lastName:
+          type: "string"
+        stripeCustomerToken:
+          type: "string"
+        username:
+          type: "string"
+        email:
+          type: "string"
+        password:
+          type: "string"
+        address:
+          $ref: "#/components/schemas/AddressDto"