From b6e5668452c7b24a3e1ce047e1b9c3ebd94b57ea Mon Sep 17 00:00:00 2001 From: yoshidakenji <181298858+kenjiyoshid-a@users.noreply.github.com> Date: Tue, 14 Jan 2025 13:31:40 +0900 Subject: [PATCH] =?UTF-8?q?consumer=E3=81=AEjavadoc=E3=82=92=E4=BF=AE?= =?UTF-8?q?=E6=AD=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../web-consumer/api-specification.json | 108 +++++++++--------- .../dressca/web/consumer/WebApplication.java | 7 +- .../web/consumer/config/DresscaWebConfig.java | 6 +- .../web/consumer/config/H2ServerLauncher.java | 6 +- .../consumer/controller/AssetsController.java | 18 +-- .../controller/BasketItemController.java | 74 ++++++------ .../controller/CatalogBrandsController.java | 8 +- .../CatalogCategoriesController.java | 6 +- .../controller/CatalogItemsController.java | 18 +-- .../consumer/controller/OrderController.java | 26 ++--- .../dto/accounting/AccountResponse.java | 2 +- .../dto/baskets/BasketItemResponse.java | 2 +- .../dto/baskets/BasketResponse.java | 2 +- .../dto/baskets/PostBasketItemsRequest.java | 2 +- .../dto/baskets/PutBasketItemsRequest.java | 2 +- .../dto/catalog/CatalogBrandResponse.java | 2 +- .../dto/catalog/CatalogCategoryResponse.java | 2 +- .../dto/catalog/CatalogItemResponse.java | 2 +- .../catalog/CatalogItemSummaryResponse.java | 2 +- .../PagedListOfCatalogItemResponse.java | 4 +- .../dto/order/OrderItemResponse.java | 2 +- .../controller/dto/order/OrderResponse.java | 2 +- .../dto/order/PostOrderRequest.java | 2 +- .../web/consumer/filter/BuyerIdFilter.java | 2 +- .../web/consumer/mapper/BasketItemMapper.java | 13 +-- .../web/consumer/mapper/BasketMapper.java | 22 ++-- .../consumer/mapper/CatalogBrandMapper.java | 4 +- .../mapper/CatalogCategoryMapper.java | 6 +- .../consumer/mapper/CatalogItemMapper.java | 22 ++-- .../mapper/CatalogItemSummaryMapper.java | 4 +- .../web/consumer/mapper/OrderItemMapper.java | 18 ++- .../web/consumer/mapper/OrderMapper.java | 17 ++- .../consumer/security/WebSecurityConfig.java | 10 +- .../web/consumer/WebApplicationTests.java | 3 + .../controller/AssetsControllerTest.java | 2 +- .../consumer/controller/HealthCheckTest.java | 2 +- .../consumer/filter/BuyerIdFilterTest.java | 6 +- 37 files changed, 219 insertions(+), 217 deletions(-) diff --git a/samples/web-csr/dressca-backend/api-docs/web-consumer/api-specification.json b/samples/web-csr/dressca-backend/api-docs/web-consumer/api-specification.json index 4c0509cde..ebcd958c8 100644 --- a/samples/web-csr/dressca-backend/api-docs/web-consumer/api-specification.json +++ b/samples/web-csr/dressca-backend/api-docs/web-consumer/api-specification.json @@ -13,16 +13,20 @@ ], "tags": [ { - "description": "カタログブランドの情報にアクセスするAPI", - "name": "CatalogBrands" + "description": "買い物かごアイテムの情報にアクセスする API", + "name": "BasketItems" }, { - "description": "注文の情報にアクセスするAPI", - "name": "Orders" + "description": "アセットの情報にアクセスする API", + "name": "Assets" }, { - "description": "カタログアイテムの情報にアクセスする API コントローラーです.", - "name": "CatalogItems" + "description": "カタログカテゴリの情報にアクセスする API", + "name": "CatalogCategories" + }, + { + "description": "カタログブランドの情報にアクセスする API", + "name": "CatalogBrands" }, { "description": "Monitor and interact", @@ -33,16 +37,12 @@ "name": "Actuator" }, { - "description": "アセットの情報にアクセスするAPI", - "name": "Assets" - }, - { - "description": "カタログカテゴリの情報にアクセスするAPI", - "name": "CatalogCategories" + "description": "カタログアイテムの情報にアクセスする API", + "name": "CatalogItems" }, { - "description": "買い物かごアイテムの情報にアクセスするAPI", - "name": "BasketItems" + "description": "注文の情報にアクセスする API", + "name": "Orders" } ], "paths": { @@ -97,7 +97,7 @@ }, "/api/assets/{assetCode}": { "get": { - "description": "与えられたアセットコードに対応するアセットを返却する.", + "description": "与えられたアセットコードに対応するアセットを返却する。", "operationId": "get", "parameters": [ { @@ -122,7 +122,7 @@ } } }, - "description": "成功." + "description": "成功。" }, "404": { "content": { @@ -132,10 +132,10 @@ } } }, - "description": "アセットコードに対応するアセットがない." + "description": "アセットコードに対応するアセットがない。" } }, - "summary": "アセットを取得する.", + "summary": "アセットを取得する。", "tags": [ "Assets" ] @@ -143,7 +143,7 @@ }, "/api/basket-items": { "get": { - "description": "買い物かごアイテムの一覧を返却する.", + "description": "買い物かごアイテムの一覧を返却する。", "operationId": "getBasketItems", "responses": { "200": { @@ -154,16 +154,16 @@ } } }, - "description": "成功." + "description": "成功。" } }, - "summary": "買い物かごアイテムの一覧を取得する.", + "summary": "買い物かごアイテムの一覧を取得する。", "tags": [ "BasketItems" ] }, "post": { - "description": "買い物かごに商品を追加します.\u003cbr\u003eこの API では、システムに登録されていないカタログアイテム Id を指定した場合 HTTP 400 を返却します.また買い物かごに追加していないカタログアイテムを指定した場合、その商品を買い物かごに追加します.すでに買い物かごに追加されているカタログアイテムを指定した場合、指定した数量、買い物かご内の数量を追加します.\u003cbr\u003e買い物かご内のカタログアイテムの数量が 0 未満になるように減じることはできません. 計算の結果数量が 0 未満になる場合 HTTP 500 を返却します.", + "description": "買い物かごに商品を追加します。\u003cbr\u003eこの API では、システムに登録されていないカタログアイテム ID を指定した場合 HTTP 400 を返却します。また買い物かごに追加していないカタログアイテムを指定した場合、その商品を買い物かごに追加します。すでに買い物かごに追加されているカタログアイテムを指定した場合、指定した数量、買い物かご内の数量を追加します。\u003cbr\u003e買い物かご内のカタログアイテムの数量が 0 未満になるように減じることはできません。計算の結果数量が 0 未満になる場合 HTTP 500 を返却します。", "operationId": "postBasketItem", "requestBody": { "content": { @@ -177,7 +177,7 @@ }, "responses": { "201": { - "description": "作成完了" + "description": "作成完了。" }, "400": { "content": { @@ -187,7 +187,7 @@ } } }, - "description": "リクエストエラー" + "description": "リクエストエラー。" }, "500": { "content": { @@ -197,16 +197,16 @@ } } }, - "description": "サーバーエラー" + "description": "サーバーエラー。" } }, - "summary": "買い物かごに商品を追加します.", + "summary": "買い物かごに商品を追加します。", "tags": [ "BasketItems" ] }, "put": { - "description": "買い物かごアイテム内の数量を変更します. 買い物かご内に存在しないカタログアイテム ID は指定できません.\u003cbr\u003eこの API では、買い物かご内に存在する商品の数量を変更できます. 買い物かご内に存在しないカタログアイテム Id を指定すると HTTP 400 を返却します.\u003cbr\u003eまたシステムに登録されていないカタログアイテム Id を指定した場合も HTTP 400 を返却します.", + "description": "買い物かごアイテム内の数量を変更します。買い物かご内に存在しないカタログアイテム ID は指定できません。\u003cbr\u003eこの API では、買い物かご内に存在する商品の数量を変更できます。買い物かご内に存在しないカタログアイテム ID を指定すると HTTP 400 を返却します。\u003cbr\u003eまたシステムに登録されていないカタログアイテム ID を指定した場合も HTTP 400 を返却します。", "operationId": "putBasketItems", "requestBody": { "content": { @@ -223,7 +223,7 @@ }, "responses": { "204": { - "description": "成功." + "description": "成功。" }, "400": { "content": { @@ -233,10 +233,10 @@ } } }, - "description": "リクエストエラー" + "description": "リクエストエラー。" } }, - "summary": "買い物かごアイテム内の数量を変更します.", + "summary": "買い物かごアイテム内の数量を変更します。", "tags": [ "BasketItems" ] @@ -244,7 +244,7 @@ }, "/api/basket-items/{catalogItemId}": { "delete": { - "description": "買い物かごから指定したカタログアイテム Id の商品を削除します.\u003cbr\u003ecatalogItemId には買い物かご内に存在するカタログアイテム Id を指定してください. カタログアイテム Id は 1 以上の整数です.0以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します. 買い物かご内に指定したカタログアイテムの商品が存在しない場合、 HTTP 404 を返却します.", + "description": "買い物かごから指定したカタログアイテム ID の商品を削除します。\u003cbr\u003ecatalogItemId には買い物かご内に存在するカタログアイテム ID を指定してください。カタログアイテム ID は 1 以上の整数です。0 以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します。買い物かご内に指定したカタログアイテムの商品が存在しない場合、 HTTP 404 を返却します。", "operationId": "deleteBasketItem", "parameters": [ { @@ -259,7 +259,7 @@ ], "responses": { "204": { - "description": "成功." + "description": "成功。" }, "400": { "content": { @@ -269,7 +269,7 @@ } } }, - "description": "リクエストエラー." + "description": "リクエストエラー。" }, "404": { "content": { @@ -279,10 +279,10 @@ } } }, - "description": "買い物かご内に指定したカタログアイテム Id がない." + "description": "買い物かご内に指定したカタログアイテム ID がない。" } }, - "summary": "買い物かごから指定したカタログアイテム Id の商品を削除します.", + "summary": "買い物かごから指定したカタログアイテム ID の商品を削除します。", "tags": [ "BasketItems" ] @@ -290,7 +290,7 @@ }, "/api/catalog-brands": { "get": { - "description": "カタログブランドの一覧を取得する.", + "description": "カタログブランドの一覧を取得する。", "operationId": "getCatalogBrands", "responses": { "200": { @@ -304,10 +304,10 @@ } } }, - "description": "成功" + "description": "成功。" } }, - "summary": "カタログブランドの一覧を取得する.", + "summary": "カタログブランドの一覧を取得する。", "tags": [ "CatalogBrands" ] @@ -315,7 +315,7 @@ }, "/api/catalog-categories": { "get": { - "description": "カタログカテゴリの一覧を取得します.", + "description": "カタログカテゴリの一覧を取得します。", "operationId": "getCatalogCategories", "responses": { "200": { @@ -329,10 +329,10 @@ } } }, - "description": "成功" + "description": "成功。" } }, - "summary": "カタログカテゴリの一覧を取得します.", + "summary": "カタログカテゴリの一覧を取得します。", "tags": [ "CatalogCategories" ] @@ -340,7 +340,7 @@ }, "/api/catalog-items": { "get": { - "description": "カタログアイテムを検索して返します.", + "description": "カタログアイテムを検索して返します。", "operationId": "getByQuery", "parameters": [ { @@ -393,7 +393,7 @@ } } }, - "description": "成功" + "description": "成功。" }, "400": { "content": { @@ -403,10 +403,10 @@ } } }, - "description": "リクエストエラー" + "description": "リクエストエラー。" } }, - "summary": "カタログアイテムを検索して返します.", + "summary": "カタログアイテムを検索して返します。", "tags": [ "CatalogItems" ] @@ -439,7 +439,7 @@ }, "/api/orders": { "post": { - "description": "買い物かごに登録されている商品を注文します.", + "description": "買い物かごに登録されている商品を注文します。", "operationId": "postOrder", "requestBody": { "content": { @@ -453,7 +453,7 @@ }, "responses": { "201": { - "description": "成功." + "description": "成功。" }, "400": { "content": { @@ -463,7 +463,7 @@ } } }, - "description": "リクエストエラー." + "description": "リクエストエラー。" }, "500": { "content": { @@ -473,10 +473,10 @@ } } }, - "description": "サーバーエラー." + "description": "サーバーエラー。" } }, - "summary": "買い物かごに登録されている商品を注文します.", + "summary": "買い物かごに登録されている商品を注文します。", "tags": [ "Orders" ] @@ -484,7 +484,7 @@ }, "/api/orders/{orderId}": { "get": { - "description": "注文情報を取得します.", + "description": "注文情報を取得します。", "operationId": "getById", "parameters": [ { @@ -506,7 +506,7 @@ } } }, - "description": "成功." + "description": "成功。" }, "404": { "content": { @@ -516,10 +516,10 @@ } } }, - "description": "注文IDが存在しない." + "description": "注文 ID が存在しない。" } }, - "summary": "注文情報を取得します.", + "summary": "注文情報を取得します。", "tags": [ "Orders" ] diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/WebApplication.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/WebApplication.java index 4be8fdbba..9fbab1da1 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/WebApplication.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/WebApplication.java @@ -7,13 +7,18 @@ import io.swagger.v3.oas.annotations.info.Info; /** - * Dresscaアプリケーションを起動するためのmainクラスです。 + * Dressca アプリケーションを起動するための main クラスです。 */ @SpringBootApplication @OpenAPIDefinition(info = @Info(title = "Dressca", description = "ECサイトDressca", version = "v1")) @ComponentScan(basePackages = { "com.dressca" }) public class WebApplication { + /** + * Dressca アプリケーションを起動します。 + * + * @param args コマンドライン引数。 + */ public static void main(String[] args) { SpringApplication.run(WebApplication.class, args); } diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/DresscaWebConfig.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/DresscaWebConfig.java index 415586f23..90305b39b 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/DresscaWebConfig.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/DresscaWebConfig.java @@ -9,7 +9,7 @@ import org.springframework.context.annotation.Configuration; /** - * Dressca Web用の設定クラス。 + * Dressca Web 用の設定クラスです。 */ @Configuration public class DresscaWebConfig { @@ -21,9 +21,9 @@ public class DresscaWebConfig { public H2ServerLauncher h2ServerLauncher; /** - * BuyerIdFilter の設定。 + * 購入者 ID のフィルターを設定します。 * - * @return BuyerIdFilter + * @return 購入者 ID のフィルター。 */ @Bean public FilterRegistrationBean buyerIdFilter() { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/H2ServerLauncher.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/H2ServerLauncher.java index 802a00d70..1f7a7f23e 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/H2ServerLauncher.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/H2ServerLauncher.java @@ -8,7 +8,7 @@ import java.sql.SQLException; /** - * 開発環境でh2データベースを立ち上げるためのクラスです。 + * 開発環境で h2 データベースを立ち上げるためのクラスです。 */ @Component @Profile("local") @@ -17,7 +17,7 @@ public class H2ServerLauncher { private Server tcpServer; /** - * h2サーバをサーバーモードで起動します。 + * h2 サーバをサーバーモードで起動します。 */ @PostConstruct public void start() { @@ -29,7 +29,7 @@ public void start() { } /** - * h2サーバを停止します。 + * h2 サーバを停止します。 */ @PreDestroy public void stop() { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/AssetsController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/AssetsController.java index ba2e1c327..626288c26 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/AssetsController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/AssetsController.java @@ -36,10 +36,10 @@ import lombok.AllArgsConstructor; /** - * {@link Asset} の情報にアクセスするAPIコントローラーです。 + * {@link Asset} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "Assets", description = "アセットの情報にアクセスするAPI") +@Tag(name = "Assets", description = "アセットの情報にアクセスする API") @RequestMapping("/api/assets") @AllArgsConstructor public class AssetsController { @@ -58,13 +58,13 @@ public class AssetsController { /** * アセットを取得します。 * - * @param assetCode アセットコード - * @return アセット + * @param assetCode アセットコード。 + * @return アセット。 */ - @Operation(summary = "アセットを取得する.", description = "与えられたアセットコードに対応するアセットを返却する.") + @Operation(summary = "アセットを取得する。", description = "与えられたアセットコードに対応するアセットを返却する。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功.", content = @Content(mediaType = "image/*", schema = @Schema(implementation = Resource.class))), - @ApiResponse(responseCode = "404", description = "アセットコードに対応するアセットがない.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "image/*", schema = @Schema(implementation = Resource.class))), + @ApiResponse(responseCode = "404", description = "アセットコードに対応するアセットがない。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @GetMapping("{assetCode}") public ResponseEntity get( @@ -93,8 +93,8 @@ public ResponseEntity get( /** * アセットタイプから Content-Type に変換します。 * - * @param asset アセット - * @return Content-Type の名称 + * @param asset アセット。 + * @return Content-Type の名称。 */ private MediaType getContentType(Asset asset) { switch (asset.getAssetType()) { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/BasketItemController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/BasketItemController.java index ca8955597..a584f244c 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/BasketItemController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/BasketItemController.java @@ -47,7 +47,7 @@ * {@link BasketItem} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "BasketItems", description = "買い物かごアイテムの情報にアクセスするAPI") +@Tag(name = "BasketItems", description = "買い物かごアイテムの情報にアクセスする API") @RequestMapping("/api/basket-items") @AllArgsConstructor public class BasketItemController { @@ -61,11 +61,11 @@ public class BasketItemController { /** * 買い物かごアイテムの一覧を取得します。 * - * @return 買い物かごアイテムの一覧 + * @return 買い物かごアイテムの一覧。 */ - @Operation(summary = "買い物かごアイテムの一覧を取得する.", description = "買い物かごアイテムの一覧を返却する.") + @Operation(summary = "買い物かごアイテムの一覧を取得する。", description = "買い物かごアイテムの一覧を返却する。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功.", content = @Content(mediaType = "application/json", schema = @Schema(implementation = BasketResponse.class))) }) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", schema = @Schema(implementation = BasketResponse.class))) }) @GetMapping public ResponseEntity getBasketItems(HttpServletRequest req) { String buyerId = req.getAttribute("buyerId").toString(); @@ -81,23 +81,23 @@ public ResponseEntity getBasketItems(HttpServletRequest req) { } /** - * 買い物かごアイテム内の数量を変更します. 買い物かご内に存在しないカタログアイテム ID は指定できません。 + * 買い物かごアイテム内の数量を変更します。買い物かご内に存在しないカタログアイテム ID は指定できません。 * *

- * この API では、買い物かご内に存在する商品の数量を変更できます。買い物かご内に存在しないカタログアイテム Id を指定すると HTTP 400 + * この API では、買い物かご内に存在する商品の数量を変更できます。買い物かご内に存在しないカタログアイテム ID を指定すると HTTP 400 * を返却します。 - * またシステムに登録されていないカタログアイテム Id を指定した場合も HTTP 400 を返却します。 + * またシステムに登録されていないカタログアイテム ID を指定した場合も HTTP 400 を返却します。 *

* - * @param putBasketItems 変更する買い物かごアイテムのデータリスト - * @return なし + * @param putBasketItems 変更する買い物かごアイテムのデータリスト。 + * @return なし。 */ - @Operation(summary = "買い物かごアイテム内の数量を変更します.", description = "買い物かごアイテム内の数量を変更します. 買い物かご内に存在しないカタログアイテム ID は指定できません.
" - + "この API では、買い物かご内に存在する商品の数量を変更できます. 買い物かご内に存在しないカタログアイテム Id を指定すると HTTP 400 を返却します.
" - + "またシステムに登録されていないカタログアイテム Id を指定した場合も HTTP 400 を返却します.") + @Operation(summary = "買い物かごアイテム内の数量を変更します。", description = "買い物かごアイテム内の数量を変更します。買い物かご内に存在しないカタログアイテム ID は指定できません。
" + + "この API では、買い物かご内に存在する商品の数量を変更できます。買い物かご内に存在しないカタログアイテム ID を指定すると HTTP 400 を返却します。
" + + "またシステムに登録されていないカタログアイテム ID を指定した場合も HTTP 400 を返却します。") @ApiResponses(value = { - @ApiResponse(responseCode = "204", description = "成功.", content = @Content), - @ApiResponse(responseCode = "400", description = "リクエストエラー", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "204", description = "成功。", content = @Content), + @ApiResponse(responseCode = "400", description = "リクエストエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @PutMapping() public ResponseEntity putBasketItems(@RequestBody List putBasketItems, @@ -142,7 +142,7 @@ public ResponseEntity putBasketItems(@RequestBody List * 買い物かごに商品を追加します。 * *

- * この API では、システムに登録されていないカタログアイテム Id を指定した場合 HTTP 400 を返却します。 + * この API では、システムに登録されていないカタログアイテム ID を指定した場合 HTTP 400 を返却します。 * また買い物かごに追加していないカタログアイテムを指定した場合、その商品を買い物かごに追加します。 * すでに買い物かごに追加されているカタログアイテムを指定した場合、指定した数量、買い物かご内の数量を追加します。 *

@@ -152,18 +152,18 @@ public ResponseEntity putBasketItems(@RequestBody List * を返却します。 *

* - * @param postBasketItem 追加する商品の情報 - * @return なし + * @param postBasketItem 追加する商品の情報。 + * @return なし。 */ - @Operation(summary = "買い物かごに商品を追加します.", description = "買い物かごに商品を追加します.
" - + "この API では、システムに登録されていないカタログアイテム Id を指定した場合 HTTP 400 を返却します." - + "また買い物かごに追加していないカタログアイテムを指定した場合、その商品を買い物かごに追加します." - + "すでに買い物かごに追加されているカタログアイテムを指定した場合、指定した数量、買い物かご内の数量を追加します.
" - + "買い物かご内のカタログアイテムの数量が 0 未満になるように減じることはできません. 計算の結果数量が 0 未満になる場合 HTTP 500 を返却します.") + @Operation(summary = "買い物かごに商品を追加します。", description = "買い物かごに商品を追加します。
" + + "この API では、システムに登録されていないカタログアイテム ID を指定した場合 HTTP 400 を返却します。" + + "また買い物かごに追加していないカタログアイテムを指定した場合、その商品を買い物かごに追加します。" + + "すでに買い物かごに追加されているカタログアイテムを指定した場合、指定した数量、買い物かご内の数量を追加します。
" + + "買い物かご内のカタログアイテムの数量が 0 未満になるように減じることはできません。計算の結果数量が 0 未満になる場合 HTTP 500 を返却します。") @ApiResponses(value = { - @ApiResponse(responseCode = "201", description = "作成完了", content = @Content), - @ApiResponse(responseCode = "400", description = "リクエストエラー", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), - @ApiResponse(responseCode = "500", description = "サーバーエラー", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "201", description = "作成完了。", content = @Content), + @ApiResponse(responseCode = "400", description = "リクエストエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), + @ApiResponse(responseCode = "500", description = "サーバーエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @PostMapping public ResponseEntity postBasketItem(@RequestBody PostBasketItemsRequest postBasketItem, @@ -189,25 +189,25 @@ public ResponseEntity postBasketItem(@RequestBody PostBasketItemsRequest post } /** - * 買い物かごから指定したカタログアイテム Id の商品を削除します。 + * 買い物かごから指定したカタログアイテム ID の商品を削除します。 * *

- * catalogItemId には買い物かご内に存在するカタログアイテム Id を指定してください。 カタログアイテム Id は 1 以上の整数です。 - * 0以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します。 買い物かご内に指定したカタログアイテムの商品が存在しない場合、 + * catalogItemId には買い物かご内に存在するカタログアイテム ID を指定してください。 カタログアイテム ID は 1 以上の整数です。 + * 0 以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します。 買い物かご内に指定したカタログアイテムの商品が存在しない場合、 * HTTP 404 を返却します。 *

* - * @param catalogItemId カタログアイテム Id - * @return なし + * @param catalogItemId カタログアイテム ID 。 + * @return なし。 */ - @Operation(summary = "買い物かごから指定したカタログアイテム Id の商品を削除します.", description = "買い物かごから指定したカタログアイテム Id の商品を削除します.
" - + "catalogItemId には買い物かご内に存在するカタログアイテム Id を指定してください. カタログアイテム Id は 1 以上の整数です." - + "0以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します. " - + "買い物かご内に指定したカタログアイテムの商品が存在しない場合、 HTTP 404 を返却します.") + @Operation(summary = "買い物かごから指定したカタログアイテム ID の商品を削除します。", description = "買い物かごから指定したカタログアイテム ID の商品を削除します。
" + + "catalogItemId には買い物かご内に存在するカタログアイテム ID を指定してください。カタログアイテム ID は 1 以上の整数です。" + + "0 以下の値を指定したり、整数値ではない値を指定した場合 HTTP 400 を返却します。" + + "買い物かご内に指定したカタログアイテムの商品が存在しない場合、 HTTP 404 を返却します。") @ApiResponses(value = { - @ApiResponse(responseCode = "204", description = "成功.", content = @Content), - @ApiResponse(responseCode = "400", description = "リクエストエラー.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), - @ApiResponse(responseCode = "404", description = "買い物かご内に指定したカタログアイテム Id がない.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "204", description = "成功。", content = @Content), + @ApiResponse(responseCode = "400", description = "リクエストエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), + @ApiResponse(responseCode = "404", description = "買い物かご内に指定したカタログアイテム ID がない。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @DeleteMapping("{catalogItemId}") public ResponseEntity deleteBasketItem(@PathVariable("catalogItemId") long catalogItemId, diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogBrandsController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogBrandsController.java index 899136a60..91208dd8c 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogBrandsController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogBrandsController.java @@ -24,7 +24,7 @@ * {@link CatalogBrand} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "CatalogBrands", description = "カタログブランドの情報にアクセスするAPI") +@Tag(name = "CatalogBrands", description = "カタログブランドの情報にアクセスする API") @RequestMapping("/api/catalog-brands") @AllArgsConstructor public class CatalogBrandsController { @@ -35,11 +35,11 @@ public class CatalogBrandsController { /** * カタログブランドの一覧を取得します。 * - * @return カタログブランドの一覧 + * @return カタログブランドの一覧。 */ - @Operation(summary = "カタログブランドの一覧を取得する.", description = "カタログブランドの一覧を取得する.") + @Operation(summary = "カタログブランドの一覧を取得する。", description = "カタログブランドの一覧を取得する。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = CatalogBrandResponse.class)))) }) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = CatalogBrandResponse.class)))) }) @GetMapping() public ResponseEntity> getCatalogBrands() { List brands = this.service.getBrands().stream() diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogCategoriesController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogCategoriesController.java index fa74a450a..033c78624 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogCategoriesController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogCategoriesController.java @@ -24,7 +24,7 @@ * {@link CatalogCategory} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "CatalogCategories", description = "カタログカテゴリの情報にアクセスするAPI") +@Tag(name = "CatalogCategories", description = "カタログカテゴリの情報にアクセスする API") @RequestMapping("/api/catalog-categories") @AllArgsConstructor public class CatalogCategoriesController { @@ -37,9 +37,9 @@ public class CatalogCategoriesController { * * @return カタログカテゴリの一覧。 */ - @Operation(summary = "カタログカテゴリの一覧を取得します.", description = "カタログカテゴリの一覧を取得します.") + @Operation(summary = "カタログカテゴリの一覧を取得します。", description = "カタログカテゴリの一覧を取得します。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = CatalogCategoryResponse.class)))) }) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", array = @ArraySchema(schema = @Schema(implementation = CatalogCategoryResponse.class)))) }) @GetMapping() public ResponseEntity> getCatalogCategories() { List categories = this.service.getCategories().stream() diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogItemsController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogItemsController.java index b34016755..c1256adf7 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogItemsController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/CatalogItemsController.java @@ -26,7 +26,7 @@ * {@link CatalogItem} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "CatalogItems", description = "カタログアイテムの情報にアクセスする API コントローラーです.") +@Tag(name = "CatalogItems", description = "カタログアイテムの情報にアクセスする API") @RequestMapping("/api/catalog-items") @AllArgsConstructor public class CatalogItemsController { @@ -37,16 +37,16 @@ public class CatalogItemsController { /** * カタログアイテムを検索して返します。 * - * @param brandId ブランドID - * @param categoryId カテゴリID - * @param page ページ番号。未指定の場合は1。 - * @param pageSize ページサイズ。未指定の場合は20。 - * @return カタログアイテムの一覧 + * @param brandId ブランド ID 。 + * @param categoryId カテゴリ ID 。 + * @param page ページ番号。未指定の場合は 1 。 + * @param pageSize ページサイズ。未指定の場合は 20 。 + * @return カタログアイテムの一覧。 */ - @Operation(summary = "カタログアイテムを検索して返します.", description = "カタログアイテムを検索して返します.") + @Operation(summary = "カタログアイテムを検索して返します。", description = "カタログアイテムを検索して返します。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功", content = @Content(mediaType = "application/json", schema = @Schema(implementation = PagedListOfCatalogItemResponse.class))), - @ApiResponse(responseCode = "400", description = "リクエストエラー", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", schema = @Schema(implementation = PagedListOfCatalogItemResponse.class))), + @ApiResponse(responseCode = "400", description = "リクエストエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @GetMapping() public ResponseEntity getByQuery( diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/OrderController.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/OrderController.java index 02d8509ce..187b69915 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/OrderController.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/OrderController.java @@ -41,10 +41,10 @@ import org.springframework.web.bind.annotation.RestController; /** - * {@link Order} の情報にアクセスするAPIコントローラーです。 + * {@link Order} の情報にアクセスする API コントローラーです。 */ @RestController -@Tag(name = "Orders", description = "注文の情報にアクセスするAPI") +@Tag(name = "Orders", description = "注文の情報にアクセスする API") @AllArgsConstructor @RequestMapping("/api/orders") public class OrderController { @@ -62,13 +62,13 @@ public class OrderController { /** * 注文情報を取得します。 * - * @param orderId 注文 Id - * @return 注文情報 + * @param orderId 注文 ID 。 + * @return 注文情報。 */ - @Operation(summary = "注文情報を取得します.", description = "注文情報を取得します.") + @Operation(summary = "注文情報を取得します。", description = "注文情報を取得します。") @ApiResponses(value = { - @ApiResponse(responseCode = "200", description = "成功.", content = @Content(mediaType = "application/json", schema = @Schema(implementation = OrderResponse.class))), - @ApiResponse(responseCode = "404", description = "注文IDが存在しない.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) + @ApiResponse(responseCode = "200", description = "成功。", content = @Content(mediaType = "application/json", schema = @Schema(implementation = OrderResponse.class))), + @ApiResponse(responseCode = "404", description = "注文 ID が存在しない。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @GetMapping("{orderId}") public ResponseEntity getById(@PathVariable("orderId") long orderId, @@ -98,13 +98,13 @@ public ResponseEntity getById(@PathVariable("orderId") long orderId, /** * 買い物かごに登録されている商品を注文します。 * - * @param postOrderInput 注文に必要な配送先などの情報 - * @return なし + * @param postOrderInput 注文に必要な配送先などの情報。 + * @return なし。 */ - @Operation(summary = "買い物かごに登録されている商品を注文します.", description = "買い物かごに登録されている商品を注文します.") - @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "成功.", content = @Content), - @ApiResponse(responseCode = "400", description = "リクエストエラー.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), - @ApiResponse(responseCode = "500", description = "サーバーエラー.", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) + @Operation(summary = "買い物かごに登録されている商品を注文します。", description = "買い物かごに登録されている商品を注文します。") + @ApiResponses(value = { @ApiResponse(responseCode = "201", description = "成功。", content = @Content), + @ApiResponse(responseCode = "400", description = "リクエストエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))), + @ApiResponse(responseCode = "500", description = "サーバーエラー。", content = @Content(mediaType = "application/problem+json", schema = @Schema(implementation = ProblemDetail.class))) }) @PostMapping public ResponseEntity postOrder(@RequestBody @Valid PostOrderRequest postOrderInput, HttpServletRequest req) { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/accounting/AccountResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/accounting/AccountResponse.java index 3075cd67b..e70aa0094 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/accounting/AccountResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/accounting/AccountResponse.java @@ -7,7 +7,7 @@ import lombok.NoArgsConstructor; /** - * 買い物かごの会計情報を格納するdtoクラスです。 + * 買い物かごの会計情報を格納する dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketItemResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketItemResponse.java index e6a681aa3..c691439c5 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketItemResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketItemResponse.java @@ -8,7 +8,7 @@ import lombok.NoArgsConstructor; /** - * 買い物かごに格納された単一の商品情報を格納するレスポンスクラスです。 + * 買い物かごに格納された単一の商品情報を格納する dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketResponse.java index 63a463fc0..9007f2212 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/BasketResponse.java @@ -8,7 +8,7 @@ import lombok.NoArgsConstructor; /** - * 買い物かごアイテムの一覧を格納するためのdtoクラスです。 + * 買い物かごアイテムの一覧を格納するための dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PostBasketItemsRequest.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PostBasketItemsRequest.java index c1f613dff..4bb39d7f1 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PostBasketItemsRequest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PostBasketItemsRequest.java @@ -6,7 +6,7 @@ import lombok.NoArgsConstructor; /** - * 買い物かごにアイテムを追加する際に用いるdtoクラスです。 + * 買い物かごにアイテムを追加する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PutBasketItemsRequest.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PutBasketItemsRequest.java index 853118ac8..bb32d904b 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PutBasketItemsRequest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/baskets/PutBasketItemsRequest.java @@ -6,7 +6,7 @@ import lombok.NoArgsConstructor; /** - * 買い物かごアイテム内の数量を変更する際に用いるdtoクラスです。 + * 買い物かごアイテム内の数量を変更する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogBrandResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogBrandResponse.java index 933167afd..71c3b8fa3 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogBrandResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogBrandResponse.java @@ -6,7 +6,7 @@ import lombok.NoArgsConstructor; /** - * カタログブランドの情報を取得する際に用いるdtoクラスです。 + * カタログブランドの情報を取得する際に用いる dto クラスです。 */ @Data @AllArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogCategoryResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogCategoryResponse.java index d5c7ba012..cc23b3d5c 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogCategoryResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogCategoryResponse.java @@ -6,7 +6,7 @@ import lombok.NoArgsConstructor; /** - * カタログカテゴリの情報を取得する際に用いるdtoクラスです。 + * カタログカテゴリの情報を取得する際に用いる dto クラスです。 */ @Data @AllArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemResponse.java index a1f67be25..56485fd58 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemResponse.java @@ -8,7 +8,7 @@ import lombok.NoArgsConstructor; /** - * カタログアイテムを取得する際に用いるdtoクラスです。 + * カタログアイテムを取得する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemSummaryResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemSummaryResponse.java index d63c3c7a0..e02cb70c4 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemSummaryResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/CatalogItemSummaryResponse.java @@ -7,7 +7,7 @@ import lombok.NoArgsConstructor; /** - * カタログアイテムの概要を取得する際に用いるdtoクラスです。 + * カタログアイテムの概要を取得する際に用いる dto クラスです。 */ @Data @AllArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/PagedListOfCatalogItemResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/PagedListOfCatalogItemResponse.java index cb0bbf54c..bc3bb5c7c 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/PagedListOfCatalogItemResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/catalog/PagedListOfCatalogItemResponse.java @@ -4,7 +4,7 @@ import lombok.Data; /** - * 検索したカタログアイテムの情報を取得する際に用いるdtoクラスです。 + * 検索したカタログアイテムの情報を取得する際に用いる dto クラスです。 */ @Data public class PagedListOfCatalogItemResponse { @@ -17,7 +17,7 @@ public class PagedListOfCatalogItemResponse { private boolean hasNext; /** - * コンストラクタ。 + * {@link PagedListOfCatalogItemResponse} クラスのインスタンスを初期化します。 * * @param items カタログアイテムのリスト。 * @param totalCount カタログアイテムの合計数。 diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderItemResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderItemResponse.java index 3e79af769..086648f2e 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderItemResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderItemResponse.java @@ -8,7 +8,7 @@ import lombok.NoArgsConstructor; /** - * 注文アイテムを取得する際に用いるdtoクラスです。 + * 注文アイテムを取得する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderResponse.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderResponse.java index 497510af6..ba8b9a8fd 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderResponse.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/OrderResponse.java @@ -9,7 +9,7 @@ import lombok.NoArgsConstructor; /** - * 注文情報を取得する際に用いるdtoクラスです。 + * 注文情報を取得する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/PostOrderRequest.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/PostOrderRequest.java index 349c665d9..4927bd491 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/PostOrderRequest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/controller/dto/order/PostOrderRequest.java @@ -7,7 +7,7 @@ import lombok.NoArgsConstructor; /** - * 注文情報における個人データを追加・変更する際に用いるdtoクラスです。 + * 注文情報における個人データを追加・変更する際に用いる dto クラスです。 */ @Data @NoArgsConstructor diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/filter/BuyerIdFilter.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/filter/BuyerIdFilter.java index 02db1c101..1cfa16c46 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/filter/BuyerIdFilter.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/filter/BuyerIdFilter.java @@ -17,7 +17,7 @@ import com.dressca.web.consumer.security.CookieSettings; /** - * 購入者IDにフィルターをかけるクラスです。 + * 購入者 ID にフィルターをかけるクラスです。 */ @AllArgsConstructor public class BuyerIdFilter implements Filter { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketItemMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketItemMapper.java index 7fda96242..3367444f9 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketItemMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketItemMapper.java @@ -11,8 +11,8 @@ public class BasketItemMapper { /** * {@link BasketItem} オブジェクトを {@link BasketItemResponse} に変換します。 * - * @param basketItem {@link BasketItem} オブジェクト - * @return {@link BasketItemResponse} オブジェクト + * @param basketItem {@link BasketItem} オブジェクト。 + * @return {@link BasketItemResponse} オブジェクト。 */ public static BasketItemResponse convert(BasketItem basketItem) { if (basketItem == null) { @@ -20,11 +20,10 @@ public static BasketItemResponse convert(BasketItem basketItem) { } return new BasketItemResponse( - basketItem.getCatalogItemId(), + basketItem.getCatalogItemId(), basketItem.getUnitPrice(), - basketItem.getQuantity(), - basketItem.getSubtotal(), - null - ); + basketItem.getQuantity(), + basketItem.getSubtotal(), + null); } } diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketMapper.java index fdf1f0b61..9e841676e 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/BasketMapper.java @@ -16,8 +16,8 @@ public class BasketMapper { /** * {@link Basket} オブジェクトを {@link BasketResponse} に変換します。 * - * @param basket {@link Basket} オブジェクト - * @return {@link BasketResponse} オブジェクト + * @param basket {@link Basket} オブジェクト。 + * @return {@link BasketResponse} オブジェクト。 */ public static BasketResponse convert(Basket basket) { if (basket == null) { @@ -25,19 +25,17 @@ public static BasketResponse convert(Basket basket) { } Account account = basket.getAccount(); - AccountResponse accountDto = - new AccountResponse( - Account.CONSUMPTION_TAX_RATE, - account.getItemTotalPrice(), - account.getDeliveryCharge(), - account.getConsumptionTax(), - account.getTotalPrice() - ); - + AccountResponse accountDto = new AccountResponse( + Account.CONSUMPTION_TAX_RATE, + account.getItemTotalPrice(), + account.getDeliveryCharge(), + account.getConsumptionTax(), + account.getTotalPrice()); + List basketItems = basket.getItems().stream() .map(BasketItemMapper::convert) .collect(Collectors.toList()); - + return new BasketResponse(basket.getBuyerId(), accountDto, basketItems); } } diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogBrandMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogBrandMapper.java index 81ac7ee2d..63ca2f9dc 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogBrandMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogBrandMapper.java @@ -11,8 +11,8 @@ public class CatalogBrandMapper { /** * {@link CatalogBrand} オブジェクトを {@link CatalogBrandResponse} に変換します。 * - * @param catalogBrand オブジェクト - * @return {@link CatalogBrandResponse} オブジェクト + * @param catalogBrand オブジェクト。 + * @return {@link CatalogBrandResponse} オブジェクト。 */ public static CatalogBrandResponse convert(CatalogBrand catalogBrand) { if (catalogBrand == null) { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogCategoryMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogCategoryMapper.java index 44a028c19..d0ba421ea 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogCategoryMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogCategoryMapper.java @@ -4,15 +4,15 @@ import com.dressca.web.consumer.controller.dto.catalog.CatalogCategoryResponse; /** - * {@link CatalogCategory} と {@link CatalogCategoryResponse} のマッパーです。 + * {@link CatalogCategory} と {@link CatalogCategoryResponse} のマッパーです。 */ public class CatalogCategoryMapper { /** * {@link CatalogCategory} オブジェクトを {@link CatalogCategoryResponse} に変換します。 * - * @param catalogCategory {@link CatalogCategory} オブジェクト - * @return {@link CatalogCategoryResponse} オブジェクト + * @param catalogCategory {@link CatalogCategory} オブジェクト。 + * @return {@link CatalogCategoryResponse} オブジェクト。 */ public static CatalogCategoryResponse convert(CatalogCategory catalogCategory) { if (catalogCategory == null) { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemMapper.java index 917f4ef88..e0d622f5e 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemMapper.java @@ -7,14 +7,15 @@ import com.dressca.web.consumer.controller.dto.catalog.CatalogItemResponse; /** - * {@link CatalogItem} と {@link CatalogItemResponse} のマッパーです。 + * {@link CatalogItem} と {@link CatalogItemResponse} のマッパーです。 */ public class CatalogItemMapper { /** * {@link CatalogItem} オブジェクトを {@link CatalogItemResponse} に変換します。 - * @param item {@link CatalogItem} オブジェクト - * @return {@link CatalogItemResponse} オブジェクト + * + * @param item {@link CatalogItem} オブジェクト。 + * @return {@link CatalogItemResponse} オブジェクト。 */ public static CatalogItemResponse convert(CatalogItem item) { if (item == null) { @@ -24,16 +25,15 @@ public static CatalogItemResponse convert(CatalogItem item) { List assetCodes = item.getAssets().stream() .map(CatalogItemAsset::getAssetCode) .collect(Collectors.toList()); - + return new CatalogItemResponse( - item.getId(), - item.getName(), - item.getProductCode(), + item.getId(), + item.getName(), + item.getProductCode(), assetCodes, - item.getDescription(), - item.getPrice(), + item.getDescription(), + item.getPrice(), item.getCatalogCategoryId(), - item.getCatalogBrandId() - ); + item.getCatalogBrandId()); } } diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemSummaryMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemSummaryMapper.java index b626e7c1f..d8e71e460 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemSummaryMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/CatalogItemSummaryMapper.java @@ -13,8 +13,8 @@ public class CatalogItemSummaryMapper { /** * {@link CatalogItem} オブジェクトを {@link CatalogItemSummaryResponse} に変換します。 * - * @param item {@link CatalogItem} オブジェクト - * @return {@link CatalogItemSummaryResponse} オブジェクト + * @param item {@link CatalogItem} オブジェクト。 + * @return {@link CatalogItemSummaryResponse} オブジェクト。 */ public static CatalogItemSummaryResponse convert(CatalogItem item) { if (item == null) { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderItemMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderItemMapper.java index c70686c66..97e463191 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderItemMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderItemMapper.java @@ -14,23 +14,21 @@ public class OrderItemMapper { /** * {@link OrderItem} オブジェクトを {@link OrderItemResponse} に変換します。 * - * @param item {@link OrderItem} オブジェクト - * @return {@link OrderItemResponse} オブジェクト + * @param item {@link OrderItem} オブジェクト。 + * @return {@link OrderItemResponse} オブジェクト。 */ public static OrderItemResponse convert(OrderItem item) { return new OrderItemResponse( - item.getId(), + item.getId(), new CatalogItemSummaryResponse( - item.getItemOrdered().getCatalogItemId(), - item.getItemOrdered().getProductName(), + item.getItemOrdered().getCatalogItemId(), + item.getItemOrdered().getProductName(), item.getItemOrdered().getProductCode(), item.getAssets().stream() .map(OrderItemAsset::getAssetCode) - .collect(Collectors.toList()) - ), + .collect(Collectors.toList())), item.getQuantity(), - item.getUnitPrice(), - item.getSubTotal() - ); + item.getUnitPrice(), + item.getSubTotal()); } } diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderMapper.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderMapper.java index 94538c598..a716902b7 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderMapper.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/mapper/OrderMapper.java @@ -13,13 +13,13 @@ public class OrderMapper { /** * {@link Order} オブジェクトを {@link OrderResponse} に変換します。 * - * @param order {@link Order} オブジェクト - * @return {@link OrderResponse} オブジェクト + * @param order {@link Order} オブジェクト。 + * @return {@link OrderResponse} オブジェクト。 */ public static OrderResponse convert(Order order) { return new OrderResponse( - order.getId(), - order.getBuyerId(), + order.getId(), + order.getBuyerId(), order.getOrderDate(), order.getShipToAddress().getFullName(), order.getShipToAddress().getAddress().getPostalCode(), @@ -27,12 +27,11 @@ public static OrderResponse convert(Order order) { order.getShipToAddress().getAddress().getShikuchoson(), order.getShipToAddress().getAddress().getAzanaAndOthers(), new AccountResponse( - order.getConsumptionTaxRate(), + order.getConsumptionTaxRate(), order.getTotalItemsPrice(), - order.getDeliveryCharge(), - order.getConsumptionTax(), - order.getTotalPrice() - ), + order.getDeliveryCharge(), + order.getConsumptionTax(), + order.getTotalPrice()), order.getOrderItems().stream() .map(OrderItemMapper::convert) .collect(Collectors.toList())); diff --git a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/security/WebSecurityConfig.java b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/security/WebSecurityConfig.java index b15d493f7..0fb5dce49 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/security/WebSecurityConfig.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/security/WebSecurityConfig.java @@ -11,7 +11,7 @@ import org.springframework.web.cors.CorsConfiguration; /** - * セキュリティ関連の実行クラス。 + * セキュリティ関連の実行クラスです。 */ @Configuration(proxyBeanMethods = false) @EnableWebSecurity @@ -21,11 +21,11 @@ public class WebSecurityConfig { private String[] allowedOrigins; /** - * CORS 設定を実行。 + * CORS の設定をします。 * - * @param http http リクエスト - * @return フィルターチェーン - * @throws Exception 例外 + * @param http http リクエスト。 + * @return フィルターチェーン。 + * @throws Exception 例外。 */ @Bean public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Exception { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/WebApplicationTests.java b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/WebApplicationTests.java index 12d7ec6d2..84ee6be0b 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/WebApplicationTests.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/WebApplicationTests.java @@ -4,6 +4,9 @@ import org.springframework.boot.test.context.SpringBootTest; import org.junit.jupiter.api.DisplayName; +/** + * {@link WebApplication} の動作をテストするクラスです。 + */ @SpringBootTest class WebApplicationTests { diff --git a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/AssetsControllerTest.java b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/AssetsControllerTest.java index 08064e17c..c7aa935d1 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/AssetsControllerTest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/AssetsControllerTest.java @@ -15,7 +15,7 @@ import org.springframework.test.web.servlet.MockMvc; /** - * {@link AssetsController}の動作をテストするクラスです。 + * {@link AssetsController} の動作をテストするクラスです。 */ @SpringJUnitConfig @SpringBootTest(classes = WebApplication.class) diff --git a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/HealthCheckTest.java b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/HealthCheckTest.java index b7f92ad5c..5e9a75b9e 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/HealthCheckTest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/controller/HealthCheckTest.java @@ -14,7 +14,7 @@ import org.springframework.test.web.servlet.MockMvc; /** - * ヘルスチェックAPIの動作をテストするクラスです。 + * ヘルスチェック API の動作をテストするクラスです。 */ @SpringJUnitConfig @SpringBootTest(classes = WebApplication.class) diff --git a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/filter/BuyerIdFilterTest.java b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/filter/BuyerIdFilterTest.java index d1eb5a2c5..d730acfb2 100644 --- a/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/filter/BuyerIdFilterTest.java +++ b/samples/web-csr/dressca-backend/web-consumer/src/test/java/com/dressca/web/consumer/filter/BuyerIdFilterTest.java @@ -21,7 +21,7 @@ import jakarta.servlet.http.HttpServletResponse; /** - * {@link BuyerIdFilter}の動作をテストするクラスです。 + * {@link BuyerIdFilter} の動作をテストするクラスです。 */ @SpringJUnitConfig @SpringBootTest(classes = WebApplication.class) @@ -53,7 +53,7 @@ void testDoFilter_01() throws Exception { filter.doFilter(request, response, chain); String setCookieHeader = response.getHeader(HttpHeaders.SET_COOKIE); - // Set-Cookieヘッダーの値が期待通りであることを確認 + // Set-Cookie ヘッダーの値が期待通りであることを確認 assertNotNull(setCookieHeader); assertTrue(setCookieHeader.startsWith("Dressca-Bid=")); assertTrue(setCookieHeader.contains("Path=/")); @@ -81,7 +81,7 @@ void testDoFilter_02() throws Exception { filter.doFilter(request, response, chain); String setCookieHeader = response.getHeader(HttpHeaders.SET_COOKIE); - // Set-Cookieヘッダーの値が期待通りであることを確認 + // Set-Cookie ヘッダーの値が期待通りであることを確認 assertNotNull(setCookieHeader); assertTrue(setCookieHeader.startsWith("Dressca-Bid=")); assertTrue(setCookieHeader.contains("Path=/"));