feature/IL-77/Add-OpenAPI-for-cart-package #100

shpali4 · 2023-09-17T14:38:59Z

Developer's full name:
Shamardin Vladislav
Link to Documentation:
(will be updated after merge)
Changes:
3.1 CartEndpoint was updated (implemented CartsApi, removed @Valid annotations from methods)
3.2 cart-openapi.yaml was added
3.3 pom.xml was updated
Test data
Import cart-openapi.yaml in Postman, after authorization all responses 200 OK
Conclusion:
5.1 Project was built with Apache Maven successfully.
5.2 Project was tested manually with Postman successfully.

vitaliibredun · 2023-09-17T15:31:48Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -30,14 +31,14 @@
 @RequiredArgsConstructor
 @Validated
 @RequestMapping(value = CartEndpoint.CART_URL)
-public class CartEndpoint {
+public class CartEndpoint implements CartsApi {

    public static final String CART_URL = "/api/v1/cart";

    private final CartApi cartApi;

    @PostMapping(value = "/items")


we need to @OverRide the method

They are overrided automaticly, isn't it?

using this annotation is like a best practice
it is really good idea to add it

vitaliibredun · 2023-09-17T15:32:16Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -57,7 +58,7 @@ public ResponseEntity<ShoppingSessionDto> getShoppingSession(@AuthenticationPrin
    }

    @PatchMapping(value = "/items")


we need to @OverRide the method

vitaliibredun · 2023-09-17T15:32:31Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -69,7 +70,7 @@ public ResponseEntity<ShoppingSessionDto> updateProductsQuantityInShoppingSessio
    }

    @DeleteMapping(value = "/items")


we need to @OverRide the method

vitaliibredun · 2023-09-17T15:37:37Z

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

@@ -0,0 +1,192 @@
+openapi: "3.0.3"
+
+info:


we need to write in a common style as in Zufar's example in product-openapi.yaml

info:
title: "Online-Store API"
version: "1.0.0"

vitaliibredun · 2023-09-17T15:38:51Z

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

+              schema:
+                $ref: "#/components/schemas/ShoppingSessionDto"
+
+    delete:


better to write path as in a common style

Sunagatov

Reviewed

Sunagatov · 2023-09-17T19:07:35Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java


    public static final String CART_URL = "/api/v1/cart";

    private final CartApi cartApi;

    @PostMapping(value = "/items")
-    public ResponseEntity<ShoppingSessionDto> addNewItemToShoppingSession(@RequestBody @Valid final AddNewItemsToShoppingSessionRequest request) {
+    public ResponseEntity<ShoppingSessionDto> addNewItemToShoppingSession(@RequestBody final AddNewItemsToShoppingSessionRequest request) {


Why did you delete ‘@Valid'?
Rollback it, please

With this annotation we have a trouble in case when we try to use our API not in IDE (i use Postman): Hibernate validator HV000151 "A method overriding another method must not alter the parameter constraint configuration").
In our generated interface we have the same annotation, its incorrect.
More info: https://forum.hibernate.org/viewtopic.php?p=2469903

Sunagatov · 2023-09-17T19:08:01Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -30,14 +31,14 @@
 @RequiredArgsConstructor
 @Validated
 @RequestMapping(value = CartEndpoint.CART_URL)
-public class CartEndpoint {
+public class CartEndpoint implements CartsApi {


CartApi sounds better

We are already have CartApi in this class (import com.zufar.onlinestore.cart.api.CartApi). Is it ok to use same names?

Yes, there is no problem

Sunagatov · 2023-09-17T19:09:52Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -57,7 +58,7 @@ public ResponseEntity<ShoppingSessionDto> getShoppingSession(@AuthenticationPrin
    }

    @PatchMapping(value = "/items")
-    public ResponseEntity<ShoppingSessionDto> updateProductsQuantityInShoppingSessionItem(@RequestBody @Valid final UpdateProductsQuantityInShoppingSessionItemRequest request) {


Rollback ‘@Valid' annotation, please

Sunagatov · 2023-09-17T19:10:04Z

src/main/java/com/zufar/onlinestore/cart/endpoint/CartEndpoint.java

@@ -69,7 +70,7 @@ public ResponseEntity<ShoppingSessionDto> updateProductsQuantityInShoppingSessio
    }

    @DeleteMapping(value = "/items")
-    public ResponseEntity<ShoppingSessionDto> deleteItemsFromShoppingSession(@RequestBody @Valid final DeleteItemsFromShoppingSessionRequest request) {


Rollback ‘@Valid' annotation, please

Sunagatov · 2023-09-17T19:10:20Z

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

+  - url: "http://localhost:8083"
+
+tags:
+  - name: "Carts"


Cart is better

IL-77 add OpenAPI for cart package

105d3b7

vitaliibredun reviewed Sep 17, 2023

View reviewed changes

Sunagatov reviewed Sep 17, 2023

View reviewed changes

shpali4 requested review from Sunagatov and vitaliibredun September 17, 2023 20:23

Sunagatov approved these changes Sep 17, 2023

View reviewed changes

Sunagatov merged commit 1e6c954 into development Sep 17, 2023
2 of 3 checks passed

Sunagatov deleted the feature/IL-77/Add-OpenAPI-for-cart-package branch May 10, 2024 21:07

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feature/IL-77/Add-OpenAPI-for-cart-package #100

feature/IL-77/Add-OpenAPI-for-cart-package #100

shpali4 commented Sep 17, 2023

vitaliibredun Sep 17, 2023

shpali4 Sep 17, 2023

Sunagatov Sep 17, 2023 •

edited

Loading

vitaliibredun Sep 17, 2023

vitaliibredun Sep 17, 2023

vitaliibredun Sep 17, 2023

shpali4 Sep 17, 2023

vitaliibredun Sep 17, 2023

Sunagatov left a comment

Sunagatov Sep 17, 2023

shpali4 Sep 17, 2023

Sunagatov Sep 17, 2023

shpali4 Sep 17, 2023

Sunagatov Sep 17, 2023

Sunagatov Sep 17, 2023

shpali4 Sep 17, 2023

Sunagatov Sep 17, 2023

shpali4 Sep 17, 2023

Sunagatov Sep 17, 2023

shpali4 Sep 17, 2023

		@@ -57,7 +58,7 @@ public ResponseEntity<ShoppingSessionDto> getShoppingSession(@AuthenticationPrin
		}

		@PatchMapping(value = "/items")

		@@ -69,7 +70,7 @@ public ResponseEntity<ShoppingSessionDto> updateProductsQuantityInShoppingSessio
		}

		@DeleteMapping(value = "/items")

feature/IL-77/Add-OpenAPI-for-cart-package #100

feature/IL-77/Add-OpenAPI-for-cart-package #100

Conversation

shpali4 commented Sep 17, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sunagatov Sep 17, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sunagatov left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Sunagatov Sep 17, 2023 •

edited

Loading