さくらみこ クイズアプリ用API
(1) ローカルでアプリケーションを起動しSwaggerのリンクを開く
(2) 検索欄に『/v3/api-docs.yaml』 と入力して検索する
(3) 左上の/v3/api-docs.yamlというリンクを押下すると api-docs.yamlがダウンロードされるので
元々置いてある docs/specs/api-doc.yamlと差し替える
※ masterブランチのapi-docs.ymlの記載内容が反映されるので他のブランチで差し替えてもmasterにマージするまで反映されない
※ git hub actionsを入れた後はmasterマージ時に自動で最新化されるようにしたい
管理者用APIを叩く際の認証設定の手順
- 認証自体をOFFにする場合
- spring.profile.activeに noauthを追加する
-Dspring.profiles.active = local,noauth
※ IntelliJの場合は実行構成の 有効なプロファイル欄に記載すればOK
- 認証を行う場合(参考ページ)
- ① Swagger UIからサンプルの値そのままでログインAPIを叩く(Localプロファイルのみ)
- ② レスポンスの Authorizationヘッダのの値から Bearer を除いたトークン文字列をコピーする
- ③ Swagger UIのAuthorizeボタンを押下し コピーしたトークン値を貼り付けてAuthorizeボタンを押下
- ④ 実行したいAPIを実行
| dir1 | dir2 | dir3 | dir4 | dir5 | description |
|---|---|---|---|---|---|
| docs | git hub pagesでデプロイされるAPI仕様書 | ||||
| src | |||||
| main | |||||
| application | アプリケーション層 業務ロジック関連 | ||||
| common | 共通定義系パッケージ | ||||
| annotation | 自作アノテーションを定義 | ||||
| config | 共通的なDIのConfig定義 | ||||
| constant | 定数定義用 | ||||
| utility | 共通処理の定義用 | ||||
| exception | 自作業務例外定義用パッケージ | ||||
| service | Serviceクラスの実装 メインのビジネスロジック実装箇所 | ||||
| domain | ドメイン層 AP層~ドメイン層で使用するmodelとIFの定義 | ||||
| model | |||||
| consts | Enum定義 | ||||
| dto | アプリケーション内の中間加工用のmodel定義 | ||||
| result | ドメイン層で使用する取得結果保持用のmodel定義 | ||||
| service | サービスIFの定義 | ||||
| repository | リポリトリIFの定義 | ||||
| infrastructure | インフラ層 外部サービスへのアクセス部 | ||||
| repository | リポジトリ実装クラスの作成 daoとサービス層間のビジネスロジック盛り込み | ||||
| dao | domaのデータアクセスリポジトリ DBにSQLを発行 | ||||
| model | |||||
| entity | DBから取得したデータ保持用のmodel定義 | ||||
| presentation | プレゼンテーション層 Restの送受信周りのソース定義 | ||||
| controller | RestControllerの定義用パッケージ | ||||
| validation | 入力チェック用処理の定義 | ||||
| converter | IF周りの型変換を行うパッケージ | ||||
| model | |||||
| form | Requestのbodyからバインドされるformのmodelクラス定義 | ||||
| response | Apiのレスポンスとして返却するmodelの定義 |