Takayuki-Y5991/experimentally-java

experimentally-java

---

Running the application

Docker-compose.yml内に起動に必要となるコンテナイメージを記載しています。

• アプリケーションの設定情報：Settings
• DockerComposeファイル: Docker

docker-compose up --build

Implementing

• SwaggerUI
• 認証機能(RedisとSpringSecurityを利用)
• DDL自動生成(Local環境のみ有効)
• mybatis dynamic sql導入(Client部分自動生成)
• MapStructカスタム
• Passwordハッシュ化
• Api Controller Interface 自動生成(open api generator)

How to Use

1. ユーザを作成してください。

[POST]http://localhost:9000/api/v1/member

2. APIリソースを利用するためのトークンを生成してください。 ※トークンの有効期限は2時間で設定しています。

[POST]http://localhost:9000/api/v1/auth

3. 各APIを実行できます。実行の際は、headersにトークンを付与してください。

Header    
 - Authorization: Bearer [トークン]

※ [トークン]を記載されている場所に2で発行したトークンを転記することを忘れずに。

APIの確認をGUIで行う場合は、下記を参照ください。
SwaggerUI

Notice

• 開発拡張を行うときのAPI作成に関して注意点
  • specフォルダ内に開発対象のopenapiを配置してください(※spec)。
    • path = API定義, scheme = Request
    • Response内で利用するスキーマ定義
  • APIを追加する際は、下記手順に従ってください。

Gredle Task - openApiGenerator実行