Skip to content

Commit

Permalink
consumerのjavadocを修正
Browse files Browse the repository at this point in the history
  • Loading branch information
@kenjiyoshid-a
kenjiyoshid-a committed Jan 14, 2025
1 parent c0abdc0 commit b6e5668
Show file tree
Hide file tree
Showing 37 changed files with 219 additions and 217 deletions.
108 changes: 54 additions & 54 deletions samples/web-csr/dressca-backend/api-docs/web-consumer/api-specification.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand All @@ -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": {
Expand Down Expand Up @@ -97,7 +97,7 @@
},
"/api/assets/{assetCode}": {
"get": {
"description": "与えられたアセットコードに対応するアセットを返却する.",
"description": "与えられたアセットコードに対応するアセットを返却する。",
"operationId": "get",
"parameters": [
{
Expand All @@ -122,7 +122,7 @@
}
}
},
"description": "成功."
"description": "成功。"
},
"404": {
"content": {
Expand All @@ -132,18 +132,18 @@
}
}
},
"description": "アセットコードに対応するアセットがない."
"description": "アセットコードに対応するアセットがない。"
}
},
"summary": "アセットを取得する.",
"summary": "アセットを取得する。",
"tags": [
"Assets"
]
}
},
"/api/basket-items": {
"get": {
"description": "買い物かごアイテムの一覧を返却する.",
"description": "買い物かごアイテムの一覧を返却する。",
"operationId": "getBasketItems",
"responses": {
"200": {
Expand All @@ -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": {
Expand All @@ -177,7 +177,7 @@
},
"responses": {
"201": {
"description": "作成完了"
"description": "作成完了。"
},
"400": {
"content": {
Expand All @@ -187,7 +187,7 @@
}
}
},
"description": "リクエストエラー"
"description": "リクエストエラー。"
},
"500": {
"content": {
Expand All @@ -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": {
Expand All @@ -223,7 +223,7 @@
},
"responses": {
"204": {
"description": "成功."
"description": "成功。"
},
"400": {
"content": {
Expand All @@ -233,18 +233,18 @@
}
}
},
"description": "リクエストエラー"
"description": "リクエストエラー。"
}
},
"summary": "買い物かごアイテム内の数量を変更します.",
"summary": "買い物かごアイテム内の数量を変更します。",
"tags": [
"BasketItems"
]
}
},
"/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": [
{
Expand All @@ -259,7 +259,7 @@
],
"responses": {
"204": {
"description": "成功."
"description": "成功。"
},
"400": {
"content": {
Expand All @@ -269,7 +269,7 @@
}
}
},
"description": "リクエストエラー."
"description": "リクエストエラー。"
},
"404": {
"content": {
Expand All @@ -279,18 +279,18 @@
}
}
},
"description": "買い物かご内に指定したカタログアイテム Id がない."
"description": "買い物かご内に指定したカタログアイテム ID がない。"
}
},
"summary": "買い物かごから指定したカタログアイテム Id の商品を削除します.",
"summary": "買い物かごから指定したカタログアイテム ID の商品を削除します。",
"tags": [
"BasketItems"
]
}
},
"/api/catalog-brands": {
"get": {
"description": "カタログブランドの一覧を取得する.",
"description": "カタログブランドの一覧を取得する。",
"operationId": "getCatalogBrands",
"responses": {
"200": {
Expand All @@ -304,18 +304,18 @@
}
}
},
"description": "成功"
"description": "成功。"
}
},
"summary": "カタログブランドの一覧を取得する.",
"summary": "カタログブランドの一覧を取得する。",
"tags": [
"CatalogBrands"
]
}
},
"/api/catalog-categories": {
"get": {
"description": "カタログカテゴリの一覧を取得します.",
"description": "カタログカテゴリの一覧を取得します。",
"operationId": "getCatalogCategories",
"responses": {
"200": {
Expand All @@ -329,18 +329,18 @@
}
}
},
"description": "成功"
"description": "成功。"
}
},
"summary": "カタログカテゴリの一覧を取得します.",
"summary": "カタログカテゴリの一覧を取得します。",
"tags": [
"CatalogCategories"
]
}
},
"/api/catalog-items": {
"get": {
"description": "カタログアイテムを検索して返します.",
"description": "カタログアイテムを検索して返します。",
"operationId": "getByQuery",
"parameters": [
{
Expand Down Expand Up @@ -393,7 +393,7 @@
}
}
},
"description": "成功"
"description": "成功。"
},
"400": {
"content": {
Expand All @@ -403,10 +403,10 @@
}
}
},
"description": "リクエストエラー"
"description": "リクエストエラー。"
}
},
"summary": "カタログアイテムを検索して返します.",
"summary": "カタログアイテムを検索して返します。",
"tags": [
"CatalogItems"
]
Expand Down Expand Up @@ -439,7 +439,7 @@
},
"/api/orders": {
"post": {
"description": "買い物かごに登録されている商品を注文します.",
"description": "買い物かごに登録されている商品を注文します。",
"operationId": "postOrder",
"requestBody": {
"content": {
Expand All @@ -453,7 +453,7 @@
},
"responses": {
"201": {
"description": "成功."
"description": "成功。"
},
"400": {
"content": {
Expand All @@ -463,7 +463,7 @@
}
}
},
"description": "リクエストエラー."
"description": "リクエストエラー。"
},
"500": {
"content": {
Expand All @@ -473,18 +473,18 @@
}
}
},
"description": "サーバーエラー."
"description": "サーバーエラー。"
}
},
"summary": "買い物かごに登録されている商品を注文します.",
"summary": "買い物かごに登録されている商品を注文します。",
"tags": [
"Orders"
]
}
},
"/api/orders/{orderId}": {
"get": {
"description": "注文情報を取得します.",
"description": "注文情報を取得します。",
"operationId": "getById",
"parameters": [
{
Expand All @@ -506,7 +506,7 @@
}
}
},
"description": "成功."
"description": "成功。"
},
"404": {
"content": {
Expand All @@ -516,10 +516,10 @@
}
}
},
"description": "注文IDが存在しない."
"description": "注文 ID が存在しない。"
}
},
"summary": "注文情報を取得します.",
"summary": "注文情報を取得します。",
"tags": [
"Orders"
]
Expand Down
7 changes: 6 additions & 1 deletion ...r/dressca-backend/web-consumer/src/main/java/com/dressca/web/consumer/WebApplication.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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);
}
Expand Down
6 changes: 3 additions & 3 deletions ...-backend/web-consumer/src/main/java/com/dressca/web/consumer/config/DresscaWebConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
import org.springframework.context.annotation.Configuration;

/**
* Dressca Web用の設定クラス。
* Dressca Web 用の設定クラスです。
*/
@Configuration
public class DresscaWebConfig {
Expand All @@ -21,9 +21,9 @@ public class DresscaWebConfig {
public H2ServerLauncher h2ServerLauncher;

/**
* BuyerIdFilter の設定。
* 購入者 ID のフィルターを設定します。
*
* @return BuyerIdFilter
* @return 購入者 ID のフィルター。
*/
@Bean
public FilterRegistrationBean<Filter> buyerIdFilter() {
Expand Down
Loading

0 comments on commit b6e5668

Please sign in to comment.