CRUD処理すべてを備えたREST APIの作成
概要
消耗品の在庫一覧についてAPIを作成しました。
今回は試験研究などで使用される試薬を題材にして在庫一覧表を作成しました。
プロジェクトの進捗
(作業を行いながら作成中)
https://github.com/users/sugao-2211/projects/1
APIの内容
-
Read処理
- 全件検索及び部分一致検索(クエリパラメータ)の実装
- id検索(パスパラメータ検索)の実装
- 1000以上の数字を3桁区切りで表示(1,000)する変換処理を実装
- 部分一致検索(クエリパラメータ)の例外処理(NotFoundException)
- id検索(パスパラメータ検索)の例外処理(NotFoundException)
-
Create処理
- データ登録処理の実装
- データ登録における例外処理の確認１ (MethodArgumentNotValidException)
- データ登録における例外処理の確認２ (MethodArgumentNotValidException)
- データ登録における例外処理の確認３ (HttpMessageNotReadableException)
-
Update処理
- データ更新処理の実装
- データ更新における例外処理の確認１ (NotFoundException)
- データ更新における例外処理の確認２ (MethodArgumentNotValidException)
- データ更新における例外処理の確認３ (MethodArgumentNotValidException)
- データ更新における例外処理の確認４ (HttpMessageNotReadableException)
-
Delete処理
- データ削除処理の実装
- データ削除における例外処理の確認 (NotFoundException)
データベース作成時の内容
| id | name | grade | quantity | unit | purchase |
|---|---|---|---|---|---|
| 1 | メタノール | HPLC用 | 3 | L | 2023−05−24 |
| 2 | 塩化カリウム | 特級 | 500 | g | 2023−07−19 |
| 3 | 硫酸ナトリウム | 特級 | 5 | kg | 2022-08-30 |
| 4 | グルコアミラーぜ | 生化学用 | 10000 | unit | 2023-10-11 |
| 5 | 硫酸 | 硫酸呈色用 | 500 | ｍL | 2023-04-05 |
| 6 | ピリドキシン塩酸塩 | 日本薬局方標準品 | 200 | mg | 2023-09-22 |
Read処理の実装
Read処理
以下の処理を実行 - データベース全件検索 - クエリパラメータ(name)に合致するものを部分一致検索 - 「硫酸」で検索 - クエリパラメータ(name)の部分一致検索における例外処理 - 「硝酸」で検索し例外処理を発生 - パスパラメータ(id)に合致するものを検索 - id「4」で検索 - パスパラメータ(id)の検索における例外処理 - id「9」で検索し例外処理を発生 - findById()メソッドのService単体テスト - 存在する在庫のidを指定したときに正常に在庫の情報が返されること - 存在しないidを指定したときにNotFoundExceptionが返されること - findData()メソッドのService単体テスト - 在庫名を指定しなかったときにfindAllメソッドが呼び出されること - 在庫名を指定したときにfindByNameメソッドが呼び出されること - 存在しない在庫名を指定したときに空のリストが返されること - findAll()メソッドのDB単体テスト - findAll()メソッドによって全件の在庫情報が取得できること - findByName()メソッドのDB単体テスト - 在庫名を指定したときに該当する在庫情報が取得できること - 存在しない在庫名を指定したときに空のリストが返されること - findById()メソッドのDB単体テスト - idを指定したときに該当する在庫情報が取得できること - 存在しないidを指定したときに空のOptionalが返されること - 結合テスト(全件取得) - 全件の在庫情報が取得できること - 結合テスト(在庫名による取得) - 存在する在庫名の在庫情報が取得できること - 存在しない在庫名を指定したときに空のリストが返されること - 結合テスト(idによる取得) - 存在するidの在庫情報が取得できること - 存在しないidを指定したときにNotFoundExceptionが返されること ##全件検索
- 全件検索 - curlコマンド ``` curl --location 'http://localhost:8080/stockList' ``` - 実行結果部分一致検索(クエリパラメータ検索)
- 部分一致検索(クエリパラメータ検索) - curlコマンド ``` curl --location 'http://localhost:8080/stockList?name=%E7%A1%AB%E9%85%B8' ``` 硫酸のエンコード：%E7%A1%AB%E9%85%B8 - 実行結果id検索(パスパラメータ検索)及び例外処理
- id検索(パスパラメータ検索) - curlコマンド ``` curl --location 'http://localhost:8080/stockList/4' ``` - 実行結果findById()メソッドのService単体テスト
- findById()メソッド(パスパラメータ検索)のService単体テスト - 存在する在庫のidを指定したときに正常に在庫の情報が返されること - 存在しないidを指定したときにNotFoundExceptionが返されること https://github.com/sugao-2211/stockListProject/blob/e8d7c8dd4d7a8342de67f6051d5ed96f452e8fd8/src/test/java/com/stock/stocklist/service/StockListServiceTest.java#L1-L59 - 実行結果findData()メソッドのService単体テスト
- findData()メソッドのService単体テスト - 在庫名を指定しなかったときにfindAllメソッド呼び出されて全件の在庫情報が返却されること - 存在する在庫名を指定したときにfindByNameメソッドが呼び出されて該当する在庫情報が返却されること - 存在しない在庫名を指定したときに空のListが返されること https://github.com/sugao-2211/stockListProject/blob/dac5df8cb3816a8ec91aad88ea8d47a3b48f2b52/src/test/java/com/stock/stocklist/service/StockListServiceTest.java#L52-L91 - 実行結果 - 在庫名を指定しなかったときにfindAllメソッド呼び出されて全件の在庫情報が返却されることfindAll()メソッドのDB単体テスト
- findAll()メソッドのDB単体テスト - findAll()メソッドによって全件の在庫情報が取得できること https://github.com/sugao-2211/stockListProject/blob/a3fc05a918a62fcfa01414b7aa416d632f9bc833/src/test/java/com/stock/stocklist/mapper/StockListMapperTest.java#L1-L42 https://github.com/sugao-2211/stockListProject/blob/38da884c0443afb05d3d58d154dc0cdb322ab945/src/test/resources/datasets/stockList.yml#L1-L37 https://github.com/sugao-2211/stockListProject/blob/38da884c0443afb05d3d58d154dc0cdb322ab945/src/test/resources/dbunit.yml#L1-L9 https://github.com/sugao-2211/stockListProject/blob/38da884c0443afb05d3d58d154dc0cdb322ab945/build.gradle#L18-L28 - 実行結果findByName()メソッドのDB単体テスト
- findByName()メソッドのDB単体テスト - 在庫名を指定したときに該当するの在庫情報が取得できること - 存在しない在庫名を指定したときに空のリストが返されること https://github.com/sugao-2211/stockListProject/blob/4a1c4063201ef38414f2568a0cb9ebcdc9b49825/src/test/java/com/stock/stocklist/mapper/StockListMapperTest.java#L42-L58 - 実行結果 - 在庫名を指定したときに該当するの在庫情報が取得できることfindById()メソッドのDB単体テスト
- findById()メソッドのDB単体テスト - idを指定したときに該当する在庫情報が取得できること - 存在しないidを指定したときに空のOptionalが返されること https://github.com/sugao-2211/stockListProject/blob/0b4cbbca4335d147a3c9863cffdb2ee60174b0f3/src/test/java/com/stock/stocklist/mapper/StockListMapperTest.java#L60-L76 - 実行結果 - idを指定したときに該当する在庫情報が取得できること結合テスト(全件取得)
- 結合テスト(全件取得) - 全件の在庫情報が取得できること https://github.com/sugao-2211/stockListProject/blob/0089bfae7c672a53d66ea7131b4a51ce630a0f4f/src/test/java/com/stock/stock/integrationtest/StockApiIntegrationTest.java#L1-L91 - 実行結果結合テスト(在庫名による取得)
- 結合テスト(在庫名による取得) - 存在する在庫名の在庫情報が取得できること - 存在しない在庫名を指定したときに空のリストが返されること https://github.com/sugao-2211/stockListProject/blob/df4ff7add3f37d44f499653f29eb604274f930f3/src/test/java/com/stock/stock/integrationtest/StockApiIntegrationTest.java#L91-L135 - 実行結果 - 存在する在庫名の在庫情報が取得できること結合テスト(idによる取得)
- 結合テスト(idによる取得) - 存在するidの在庫情報が取得できること - 存在しないidを指定したときにNotFoundExceptionが返されること https://github.com/sugao-2211/stockListProject/blob/b4a22715322aad9316ee27bfa95b23a61c7bdb49/src/test/java/com/stock/stock/integrationtest/StockApiIntegrationTest.java#L170-L211 - 実行結果 - 存在するidの在庫情報が取得できることCreate処理の実装
Create処理
以下の処理を実行 - データ登録 - name: 硫化ナトリウム九水和物 - grade: 特級 - quantity: 500 - unit: g - purchase: 2023-08-12 - 例外処理の確認１ (MethodArgumentNotValidException) - nameを空文字で入力 - gradeを空文字で入力 - quantityを0で入力 - unitを空文字で入力 - purchaseを空文字で入力 - 例外処理の確認２ (MethodArgumentNotValidException) - nameを101文字で入力 - purchaseを未来の日付で入力 - quantityを空文字で入力 - 例外処理の確認３ (HttpMessageNotReadableException) - quantityを文字列で入力した場合 - quantityを小数で入力した場合 - purchaseの形式が誤っている場合 - insert()メソッドのDB単体テスト - insert()メソッドによって新規の在庫情報が登録できること - insert()メソッドのService単体テスト - insert()メソッドによって新規の在庫情報が登録できること - 結合テスト(新規の在庫情報を登録) - 新規の在庫情報が登録できること - 新規の在庫情報を登録する際にnameが空文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にnameがnullのときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にnameが101文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にgradeが空文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にgradeがnullのときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にquantityが空文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にquantityがnullのときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にquantityが0のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にquantityが文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にunitが空文字のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にunitがnullのときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にpurchaseがnullのときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にpurchaseが未来の日付のときにステータスコード400及びエラーに応じたメッセージが返されること - 新規の在庫情報を登録する際にpurchaseの形式が正しくないときにステータスコード400及びエラーに応じたメッセージが返されること ##データ登録
- データ登録 - curlコマンド ``` curl --location 'http://localhost:8080/stockList' \ --header 'Content-Type: application/json' \ --data '{ "name": "硫化ナトリウム九水和物", "grade": "特級", "quantity": "500", "unit": "g", "purchase": "2023-08-12" }' ``` - 実行結果(Postman)例外処理の確認１ (MethodArgumentNotValidException)
- 例外処理の確認１ (MethodArgumentNotValidException) - nameを空文字で入力 - gradeを空文字で入力 - quantityを0で入力 - unitを空文字で入力 - purchaseを空文字で入力 - 実行結果例外処理の確認２ (MethodArgumentNotValidException)
- 例外処理の確認２ (MethodArgumentNotValidException) - nameを101文字で入力 - purchaseを未来の日付で入力 - quantityを空文字で入力 - 実行結果 - nameを101文字で入力 - purchaseを未来の日付で入力例外処理の確認３ (HttpMessageNotReadableException)
- 例外処理の確認３ (HttpMessageNotReadableException) - quantityを文字列で入力した場合 - quantityを小数で入力した場合 - purchaseの形式が誤っている場合 - 実行結果 - quantityを文字列で入力した場合- quantityを小数で入力した場合
- purchaseの形式が誤っている場合