未経験からのエンジニア転職に向けてSpringBootでREST APIを作成してみた

概要

API仕様書を元に業務管理アプリケーション用REST APIを作成しました。下請業者との作業内容を共有し業務改善することを目指し、主な機能は以下の通りです。

• 作業予定・作業実績を登録・編集・削除できる
• 作業予定・作業実績の一覧表を表示できる
• 過去の作業予定・作業実績の履歴を検索できる

記事元のGitHubと全体仕様書は別のREADMEにまとめております

作成背景

現在、電気設備工事の現場監督（サブゼネコン）として働いています。建築（ゼネコン）との業務管理はアプリケーションで管理しておりますが、サブゼネコンとの下請け業者とはアナログ管理でしています。

組織構成図

アナログ管理とは、口頭や電話などでメモしたりやペーパー等に記入するという意味で、それによる聞き漏れや聞き忘れ等が発生や何十社と電話で確認をするのに時間がかかります。

アナログ管理イメージ図

そこで、対策としてGoogle Apps Script（GAS）+　Google Forms　＋　LINEを連携したLINE自動通知送信システムを開発し運用しています。

Line自動通知送信システム構成図

上記のシステムにより、電話をする時間から解放され、どこの会社が何の業務をしているかを共有化できました。
しかし、運用していて以下のでデメリットがありました。

• 業務内容の更新・削除ができない
• 下請業者が多くなるとLINEをスクロールして確認するのが大変
• 過去の業務を確認はできるが探すのが大変

これらを解決できるアプリケーションを開発したいと思います。

主な技術

バックエンド

• Java 17
• Spring Boot v2.7.5

インフラ・DB

• Docker/Docker compose
• AWS(VPC・EC2)
• MySQL

CI

• GitHub Actions

ディレクトリ構成

※　一部省略あり
...
├── docker-compose.yaml
├── mysql
│   └── sql
│       ├── initdb.d
│       │   ├── 1_schema.sql
│       │   └── 2_data.sql
│       └── my.cnf
└── src
    ├── main
    │   ├── java
    │   │   └── com
    │   │       └── example
    │   │           └── businessmanagement
    │   │               ├── BusinessManagement2Application.java
    │   │               ├── controller
    │   │               │   ├── advice
    │   │               │   │   ├── BadRequestError.java
    │   │               │   │   ├── BadRequestErrorCreator.java
    │   │               │   │   ├── CustomExceptionHandler.java
    │   │               │   │   ├── InvalidParam.java
    │   │               │   │   └── ResourceNotFoundError.java
    │   │               │   ├── performance
    │   │               │   │   ├── PerformanceController.java
    │   │               │   │   ├── PerformanceDTO.java
    │   │               │   │   ├── PerformanceForm.java
    │   │               │   │   ├── PerformanceListDTO.java
    │   │               │   │   └── PerformanceResponseMassage.java
    │   │               │   ├── schedule
    │   │               │   │   ├── ScheduleController.java
    │   │               │   │   ├── ScheduleDTO.java
    │   │               │   │   ├── ScheduleForm.java
    │   │               │   │   ├── ScheduleListDTO.java
    │   │               │   │   └── ScheduleResponseMassage.java
    │   │               │   ├── user
    │   │               │   │   ├── UserController.java
    │   │               │   │   ├── UserDTO.java
    │   │               │   │   ├── UserForm.java
    │   │               │   │   ├── UserListDTO.java
    │   │               │   │   └── UserResponseMessage.java
    │   │               │   ├── userperformance
    │   │               │   │   ├── UserPerformanceController.java
    │   │               │   │   ├── UserPerformanceDTO.java
    │   │               │   │   └── UserPerformanceListDTO.java
    │   │               │   └── userschedule
    │   │               │       ├── UserScheduleController.java
    │   │               │       ├── UserScheduleDTO.java
    │   │               │       └── UserScheduleListDTO.java
    │   │               ├── repository
    │   │               │   ├── performance
    │   │               │   │   ├── PerformanceEntity.java
    │   │               │   │   └── PerformanceRepository.java
    │   │               │   ├── schedule
    │   │               │   │   ├── ScheduleEntity.java
    │   │               │   │   └── ScheduleRepository.java
    │   │               │   ├── user
    │   │               │   │   ├── UserEntity.java
    │   │               │   │   └── UserRepository.java
    │   │               │   ├── userperformance
    │   │               │   │   ├── UserPerformance.java
    │   │               │   │   └── UserPerformanceRepository.java
    │   │               │   └── userschedule
    │   │               │       ├── UserSchedule.java
    │   │               │       └── UserScheduleRepository.java
    │   │               └── service
    │   │                   ├── performance
    │   │                   │   ├── PerformanceEntityNotFoundException.java
    │   │                   │   ├── PerformanceService.java
    │   │                   │   └── PerformanceServiceImpl.java
    │   │                   ├── schedule
    │   │                   │   ├── ScheduleEntityNotFoundException.java
    │   │                   │   ├── ScheduleService.java
    │   │                   │   └── ScheduleServiceImpl.java
    │   │                   ├── user
    │   │                   │   ├── UserEntityNotFoundException.java
    │   │                   │   ├── UserService.java
    │   │                   │   └── UserServiceImpl.java
    │   │                   ├── userperformance
    │   │                   │   ├── UserPerformanceService.java
    │   │                   │   └── UserPerformanceServiceImpl.java
    │   │                   └── userschedule
    │   │                       ├── UserScheduleService.java
    │   │                       └── UserScheduleServiceImpl.java
    │   └── resources
    │       ├── application.yml
    │       └── com
    │           └── example
    │               └── businessmanagement
    │                   └── repository
    │                       ├── performance
    │                       │   └── PerformanceRepository.xml
    │                       ├── schedule
    │                       │   └── ScheduleRepository.xml
    │                       ├── user
    │                       │   └── UserRepository.xml
    │                       ├── userperformance
    │                       │   └── UserPerformanceRepository.xml
    │                       └── userschedule
    │                           └── UserScheduleRepository.xml
    └── test
        ├── java
        │   └── com
        │       └── example
        │           └── businessmanagement
        │               ├── BusinessManagement2ApplicationTests.java
        │               ├── performance
        │               │   ├── PerformanceApiIntegrationTest.java
        │               │   ├── PerformanceRepositoryTest.java
        │               │   └── PerformanceServiceTest.java
        │               ├── schedule
        │               │   ├── ScheduleApiIntegrationTest.java
        │               │   ├── ScheduleRepositoryTest.java
        │               │   └── ScheduleServiceTest.java
        │               ├── user
        │               │   ├── UserRepositoryTest.java
        │               │   ├── UserRestApiIntegrationTest.java
        │               │   └── UserServiceTest.java
        │               ├── userperformance
        │               │   ├── UserScheduleApiIntegrationTest.java
        │               │   ├── UserScheduleRepositoryTest.java
        │               │   └── UserScheduleServiceTest.java
        │               └── userschedule
        │                   ├── UserScheduleApiIntegrationTest.java
        │                   ├── UserScheduleRepositoryTest.java
        │                   └── UserScheduleServiceTest.java
        └── resources
            ├── dbunit.yml
            ├── performance
            │   └── datasets
            │       ├── createperformances.yml
            │       ├── deleteperformances.yml
            │       ├── performances.yml
            │       └── updateperformances.yml
            ├── schedule
            │   └── datasets
            │       ├── createschedules.yml
            │       ├── deleteschedules.yml
            │       ├── schedules.yml
            │       └── updateschedules.yml
            ├── user
            │   └── datasets
            │       ├── createusers.yml
            │       ├── deleteusers.yml
            │       ├── updateusers.yml
            │       └── users.yml
            ├── userperformance
            │   └── datasets
            │       └── userperformances.yml
            └── userschedule
                └── datasets
                    └── userschedules.yml

設計書

ER図

URL設計

インフラ構成図

デプロイ状況

Postmanで確認

テスト

以下にそれぞれの統合テスト・単独テスト・DBテストを記載します。

user

統合テスト表

メソッド	テスト内容	ポート
GET	ユーザーが全件取得に成功すると200で内容を返すこと	200
GET	ユーザーが全件取得できること	200
GET	存在するユーザのIDを指定したとき正常にユーザーが返されること	200
GET	存在しないユーザーのidにアクセスしたときにと404が返ること	404
GET	検索時に該当するIDのユーザーがいないときエラーメッセージが返ること	404
POST	ユーザー登録に成功すると201とレスポンスメッセージを返すこと	201
POST	ユーザー登録時空文字nullの場合エラーメッセージを返すこと	400
POST	ユーザー登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
PATCH	ユーザー更新に成功すると200とレスポンスメッセージを返すこと	200
PATCH	ユーザー更新時に該当するIDのユーザーがいないときエラーメッセージを返すこ	404
PATCH	ユーザー登録時空文字nullの場合エラーメッセージを返すこと	400
PATCH	ユーザー登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
DELETE	指定したデーターを1件削除できること	204
DELETE	削除時に該当するIDのユーザーがいないときエラーメッセージが返ること	404

単体テスト表（Service）

メソッド	テスト内容	ポート
GET	すべてのユーザーを全件取得してそのまま返すこと	200
GET	存在するユーザのIDを指定したとき正常にユーザーが返されること	200
GET	検索時に該当するIDのユーザーがいないときUserEntityNotFoundExceptionとなること	404
POST	ユーザーを新規登録できること	201
PATCH	指定したIDのユーザーを更新できること	200
PATCH	更新時に該当するIDのユーザーがいないときUserEntityNotFoundExceptionとなること	404
DELETE	指定したデーターを1件削除できること	204
DELETE	削除時に該当するIDのユーザーがいないときUserEntityNotFoundExceptionとなること	404

DBテスト表

メソッド	テスト内容	ポート
GET	すべてのユーザーが取得できること	200
GET	存在するユーザのIDを指定してユーザーが取得できること	200
GET	ユーザーが登録いされてないときに空のリストが返ること	404
POST	ユーザーを新規登録できること	201
PATCH	キーに紐づく1件の更新が出来ること	200
DELETE	指定したデーターを1件削除できること	204

schedule

統合テスト表

メソッド	テスト内容	ポート
GET	作業予定が全件取得に成功すると200で内容を返すこと	200
GET	作業予定が全件取得できること	200
GET	存在する作業予定のIDを指定したとき正常に作業予定が返されること	200
GET	存在しない作業予定のidにアクセスしたときにと404が返ること	404
GET	検索時に該当するIDの作業予定がいないときエラーメッセージが返ること	404
POST	作業予定の登録に成功すると201とLocationヘッダーとレスポンスメッセージを返すこと	201
POST	作業予定登録時過去の日付入力した場合エラーメッセージを返すこと	400
POST	作業予定登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
POST	作業予定登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
POST	作業予定登録時空白がある場合エラーメッセージを返すこと	400
PATCH	作業予定更新に成功すると200とレスポンスメッセージを返すこと	200
PATCH	作業予定更新時に該当するIDの作業予定がいないときエラーメッセージを返すこと	404
PATCH	作業予定更新時文字数が256文字以上の場合エラーメッセージを返すこと	400
PATCH	作業予定更新時人数が０の場合エラーメッセージを返すこと	400
PATCH	作業予定更新時人数が200以上の場合エラーメッセージを返すこと	400
DELETE	指定した作業予定を1件削除できること	204
DELETE	削除時に該当するIDの作業予定がいないときエラーメッセージが返ること	404

単体テスト表(Service)　

メソッド	テスト内容	ポート
GET	すべての作業予定を全件取得してそのまま返すこと	200
GET	存在する作業予定のIDを指定したとき正常に作業予定が返されること	200
GET	検索時に該当するIDの作業予定がいないときScheduleEntityNotFoundExceptionとなること	404
POST	作業予定を新規登録できること	201
PATCH	指定したIDの作業予定を更新できること	200
PATCH	更新時に該当するIDの作業予定がいないときScheduleEntityNotFoundExceptionとなること	404
DELETE	指定した作業予定を1件削除できること	204
DELETE	削除時に該当するIDの作業予定がいないときScheduleEntityNotFoundExceptionとなること	404

DBテスト表

メソッド	テスト内容	ポート
GET	すべての作業予定が取得できること	200
GET	存在する作業予定のIDを指定して作業予定が取得できること	200
GET	作業予定が登録されてないときに空のリストが返ること	404
POST	作業予定を新規登録できること	201
PATCH	キーに紐づく1件の更新が出来ること	200
DELETE	指定した作業予定を1件削除できること	204

performance

統合テスト表

メソッド	テスト内容	ポート
GET	作業実績が全件取得に成功すると200で内容を返すこと	200
GET	作業実績が全件取得できること	200
GET	存在する作業実績のIDを指定したとき正常に作業実績が返されること	200
GET	存在しない作業実績のidにアクセスしたときにと404が返ること	404
GET	検索時に該当するIDの作業実績がいないときエラーメッセージが返ること	404
POST	作業実績の登録に成功すると201とLocationヘッダーとレスポンスメッセージを返すこと	201
POST	作業実績登録時過去の日付入力した場合エラーメッセージを返すこと	400
POST	作業実績登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
POST	作業実績登録時文字数が256文字以上の場合エラーメッセージを返すこと	400
POST	作業実績登録時空白がある場合エラーメッセージを返すこと	400
PATCH	作業実績更新に成功すると200とレスポンスメッセージを返すこと	200
PATCH	作業実績更新時に該当するIDの作業予定がいないときエラーメッセージを返すこと	404
PATCH	作業実績更新時文字数が256文字以上の場合エラーメッセージを返すこと	400
PATCH	作業実績更新時人数が200以上の場合エラーメッセージを返すこと	400
DELETE	指定した作業実績を1件削除できること	204
DELETE	削除時に該当するIDの作業実績がいないときエラーメッセージが返ること	404

単体テスト表(Service)　

メソッド	テスト内容	ポート
GET	すべての作業実績を全件取得してそのまま返すこと	200
GET	存在する作作業実績のIDを指定したとき正常に作業予定が返されること	200
GET	検索時に該当するIDの作業実績がいないときPerformanceEntityNotFoundExceptionとなること	404
POST	作業実績を新規登録できること	201
PATCH	指定したIDの作業実績を更新できること	200
PATCH	更新時に該当するIDの作業実績がいないときPerformanceEntityNotFoundExceptionとなること	404
DELETE	指定した作業実績を1件削除できること	204
DELETE	削除時に該当するIDの作業実績がいないときPerformanceEntityNotFoundExceptionとなること	404

DBテスト表　

メソッド	テスト内容	ポート
GET	すべての作業実績が取得できること	200
GET	存在する作業実績のIDを指定して作業実績が取得できること	200
GET	作業実績が登録されてないときに空のリストが返ること	404
POST	作業実績を新規登録できること	201
PATCH	キーに紐づく1件の更新が出来ること	200
DELETE	指定した作業実績を1件削除できること	204

userschedule

統合テスト表

メソッド	テスト内容	ポート
GET	ユーザーと作業予定が全件取得に成功すると200で内容を返すこと	200
GET	ユーザーと作業予定が全件取得できること	200
GET	存在するユーザーと作業予定のIDを指定したとき正常にユーザーと作業予定が返されること	200
GET	存在しないユーザーと作業予定のidにアクセスしたときにと404が返ること	404
GET	検索時に該当するIDのユーザーと作業予定がいないときエラーメッセージが返ること	404

単体テスト表(Service)　

メソッド	テスト内容	ポート
GET	すべてのユーザーと作業予定を全件取得してそのまま返すこと	200
GET	存在するユーザーと作業予定のIDを指定したとき正常に作業予定が返されること	200
GET	検索時に該当するIDのユーザーと作業予定がいないときUserEntityNotFoundExceptionとなること	404

DBテスト表　

メソッド	テスト内容	ポート
GET	すべてのユーザーと作業予定が取得できること	200
GET	ユーザーと作業予定が登録されてないときに空のリストが返ること	200
GET	存在するユーザーと作業予定のIDを指定してユーザーと作業予定が取得できること	404

userperformance

統合テスト表

メソッド	テスト内容	ポート
GET	ユーザーと作業実績が全件取得に成功すると200で内容を返すこと	200
GET	ユーザーと作業実績が全件取得できること	200
GET	存在するユーザーと作業実績のIDを指定したとき正常にユーザーと作業実績が返されること	200
GET	存在しないユーザーと作業実績のidにアクセスしたときにと404が返ること	404
GET	検索時に該当するIDのユーザーと作業実績がいないときエラーメッセージが返ること	404

単体テスト表(Service)　

メソッド	テスト内容	ポート
GET	すべてのユーザーと作業実績を全件取得してそのまま返すこと	200
GET	存在するユーザーと作業実績のIDを指定したとき正常にユーザーと作業実績が返されること	200
GET	検索時に該当するIDのユーザーと作業実績がいないときUserEntityNotFoundExceptionとなること	404

DBテスト表　

メソッド	テスト内容	ポート
GET	すべてのユーザーと作業実績が取得できること	200
GET	ユーザーと作業実績が登録されてないときに空のリストが返ること	200
GET	存在するユーザーと作業実績のIDを指定してユーザーと作業実績が取得できること	404

自動テスト

GitHub Actionsの導入して自動テストを行いました

工夫した点

• 仕様書や設計関係に時間をかけました。図を多めにして相手にも理解してもらえるように考えて書きました。
• ディレクトリ構成を考える時、controller層・repository層・service層それぞれの役割を考えて構成しました。
• わからない所や解決で来ない所あれば３０分〜１時間ぐらいと期限を決め質問するようにしてました。

ハマった点

• 最初にAPI仕様書作成しましたがいざ実装してみると仕様書通りにうまくいかず悩みながら実装しました。
• SQLのテーブル結合をしたものをどうSpring Bootで表示できるように実装するのか悩みました。
• 大文字や小文字の違いまたはスペルミス等でエラーしていることがありそれを探すのが大変でした。
• SQLをXMLの実装時エラー文を見てもわからないところがあったがGoogle翻訳や仮設をたてなんとか解決することができました。
• ローカルでテスト実行してエラーしなかったけどCIでエラーするという現象起こり、その場合はCIのテストレポート作成し確認をするとエラー原因がわかりました。

今後の展開

• ログイン機能に実装
• 外部連携(LINE通知機能)
• フロント実装
• 作業予定の承認時、作業実績に反映できるように実装
• AWS(ALB・Route53)構築