| api名 | HTTPメソッド | リソースパス |
|---|---|---|
| 商品一件作成 | POST | /catalog |
| 商品一件取得 | GET | /catalog/{id} |
| 商品一件更新 | PUT | /catalog/{id} |
| 商品一件削除 | DELETE | /catalog/{id} |
| 商品全件取得 | GET | /catalog/ |
- POSTデータ
| JSON key | 型 | サイズ | 値の説明 |
|---|---|---|---|
| name | 文字列 | 100 | idに基づいた商品タイトルの名前 |
| intro | 文字列 | 500 | idに基づいた商品の説明 |
| price | 数値 | idに基づいた商品の価格 | |
| imgUrl | 文字列 | idに基づいた商品画像のURL |
- 処理結果ステータス
| ステータス | 説明 |
|---|---|
| 201 | 商品の登録が成功する |
| 400 | 送信内容が空データなら400エラーとエラー文を返却する |
| 400 | name intro price imgUrlのいずれかが空データならば400エラーとエラー文を返却する |
- GETデータ
| JSON key | 型 | サイズ | 値の説明 |
|---|---|---|---|
| id | 数値 | 選択した商品のid | |
| name | 文字列 | 100 | idに基づいた商品タイトルの名前 |
| intro | 文字列 | 500 | idに基づいた商品の説明 |
| price | 数値 | idに基づいた商品の価格 | |
| imgUrl | 文字列 | idに基づいた商品画像のURL |
- 処理結果ステータス
| ステータス | 説明 |
|---|---|
| 200 | 登録されたidならば登録されたデータを取得する |
| 404 | 登録されていないidならば商品データが見つかりませんでしたと返却する |
- PUTデータ
| JSON key | 型 | サイズ | 値の説明 |
|---|---|---|---|
| id | 数値 | 選択した商品のid | |
| name | 文字列 | 100 | idに基づいた商品タイトルの名前 |
| intro | 文字列 | 500 | idに基づいた商品の説明 |
| price | 数値 | idに基づいた商品の価格 | |
| imgUrl | 文字列 | idに基づいた商品画像のURL |
- 処理結果ステータス
| ステータス | 説明 |
|---|---|
| 204 | 選択した商品のデータが更新される |
| 404 | 登録されていないデータidを更新すると商品データが見つかりませんでしたと返却する |
- DELETEデータ
| JSON key | 型 | サイズ | 値の説明 |
|---|---|---|---|
| id | 数値 | 選択した商品のid |
- 処理結果ステータス
| ステータス | 説明 |
|---|---|
| 204 | 選択した商品のデータを消去する |
| 404 | 登録されていないデータidを削除すると商品データが見つかりませんでしたと返却する |
- GETデータ
| JSON key | 型 | サイズ | 値の説明 |
|---|---|---|---|
| id | 数値 | 商品のid | |
| name | 文字列 | 100 | idに基づいた商品タイトルの名前 |
| intro | 文字列 | 500 | idに基づいた商品の説明 |
| price | 数値 | idに基づいた商品の価格 | |
| imgUrl | 文字列 | idに基づいた商品画像のURL |
- 処理結果ステータス
| ステータス | 説明 |
|---|---|
| 200 | 登録されたidならば登録されたデータを取得する |
| 404 | 商品データが空なら商品データが見つかりませんと返却する |