Skip to content

Commit 3709fa4

Browse files
ma91nma91n
authored
Add UI02 (#170)
1 parent aee47b9 commit 3709fa4

File tree

4 files changed

+154
-37
lines changed

4 files changed

+154
-37
lines changed

‎documents/forMarkdown/future_muscle_partner/docs/01_画面/UI01/UI01.md‎

Lines changed: 0 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -25,26 +25,6 @@
2525

2626
### 1. 初期表示
2727

28-
起動パラメータ:
29-
30-
| Name | Value | Memo |
31-
| --- | --- | --- |
32-
| userState | {/* 略 */} | xxx状態 |
33-
34-
初期表示イベント:
35-
36-
- xxx
37-
38-
利用API:
39-
40-
| ID | オプション |
41-
| --- | --- |
42-
| API031 | /v1/salesresult?q=xxxx&date=${current_ymd} |
43-
44-
画面表示制御:
45-
46-
xxx
47-
4828
### 2. トレーナーを探す
4929

5030
### 3. 会員登録／ログイン

‎documents/forMarkdown/future_muscle_partner/docs/01_画面/UI02/UI02.md‎

Lines changed: 89 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -13,32 +13,109 @@
1313

1414
## イベント概要
1515

16-
| No | イベント名 | イベント分類 | 　 　 処理説明 |
17-
|--- |-----------------------------------------|---------------|------------------------------------------------|
18-
| 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する |
19-
| 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 |
20-
| 3 | トレーナー検索 | ボタン押下 | 入力された条件で検索 |
21-
| 4 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 |
22-
| 5 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 |
16+
| No | イベント名 | イベント分類 | 処理説明 |
17+
|----|----------|--------|--------------------------------|
18+
| 1 | 初期表示 | 初期表示 | 初期検索条件に従いAPIを実行し、履歴表示する |
19+
| 2 | トレーナーを探す | ボタン押下 | パーソナルトレーナー検索モーダル起動 |
20+
| 3 | トレーナー検索 | ボタン押下 | 入力された条件で検索 |
21+
| 4 | 受講完了確認 | ボタン押下 | 予約済みトレーニングを受講完了に切り替えるためのモーダル起動 |
22+
| 5 | 受講完了 | ボタン押下 | 予約済みトレーニングを完了済みのトレーニングに更新 |
2323

2424
## イベント詳細
2525

2626
### 1. 初期表示
2727

28-
xxx
28+
起動パラメータ:
29+
30+
| Name | Value | Memo |
31+
| --- | --- | --- |
32+
| userState | {"user_id":"<user_id>"} | ログイン状態 |
33+
34+
初期表示イベント:
35+
36+
- マイページ表示
37+
38+
利用API:
39+
40+
| ID | URL | Parameter |
41+
| --- | --- | -- |
42+
| API-005 | GET /profile/{trainee_id} | trainee_id=userState.user_id |
43+
44+
画面表示制御:
45+
46+
- HTTPステータスが500系
47+
- メッセージID（MSG_BIZ_111）表示
48+
- HTTPステータスが400系
49+
- トップページにリダイレクト
50+
51+
利用API:
52+
53+
| ID | URL | Parameter |
54+
| --- | --- | -- |
55+
| API-013 | GET /bookings/{trainee_id} | trainee_id=userState.user_id |
56+
57+
画面表示制御:
58+
59+
- 起動条件
60+
- API-016が有効な場合
61+
- HTTPステータスが200以外
62+
- メッセージID（MSG_BIZ_111）表示
2963

3064
### 2. トレーナーを探す
3165

32-
xxx
66+
「パーソナルトレーナー検索モーダル」を起動する。
3367

3468
### 3. トレーナー検索
3569

36-
xxx
70+
利用API:
71+
72+
| ID | URL | Parameter |
73+
| --- | --- | -- |
74+
| API-007 | GET /trainers | モーダルに指定された値をクエリパラメータに設定する |
75+
76+
画面表示制御:
77+
78+
- 入力チェック
79+
- favorite_gym_name, store_nameが未設定の場合は、フロントエンド側でチェックし「行きつけのジム名・店舗名は必須項目です」と表示する
80+
- 応答が0件の場合
81+
- 「条件に一致するコーチは存在しませんでした」と表示する
82+
- HTTPステータスが200以外
83+
- メッセージID（MSG_BIZ_111）表示
3784

3885
### 3. 受講完了確認
3986

40-
xxx
87+
「`${トレーニングメニュー}` は完了しましたか？」ダイアログを表示する。
88+
89+
キャンセルの場合は閉じる。
4190

4291
### 3. 受講完了
4392

44-
xxx
93+
「`${トレーニングメニュー}` は完了しましたか？」ダイアログがOKの場合。
94+
95+
利用API:
96+
97+
| ID | URL | Parameter |
98+
| --- | --- | -- |
99+
| API-016 | PUT /booking/{booking_id}/status | 選択されたトレーニング予約ID |
100+
101+
画面表示制御:
102+
103+
- クリック可否判定
104+
- 予約済み＋現在時間<=受講時間になっている場合に、クリック可能とする
105+
- HTTPステータスが200以外
106+
- メッセージID（MSG_BIZ_111）表示
107+
- HTTPステータスが200
108+
- 次のAPIを呼び出し
109+
110+
利用API:
111+
112+
| ID | URL | Parameter |
113+
| --- | --- | -- |
114+
| API-012 | GET /bookings/{trainee_id} | trainee_id=userState.user_id |
115+
116+
画面表示制御:
117+
118+
- 起動条件
119+
- API-016が有効な場合
120+
- HTTPステータスが200以外
121+
- メッセージID（MSG_BIZ_111）表示

‎documents/forMarkdown/future_muscle_partner/docs/02_WebAPI/openapi.yaml‎

Lines changed: 63 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -157,6 +157,42 @@ paths:
157157
summary: API-007 パーソナルトレーナー検索
158158
operationId: searchTrainers
159159
security: []
160+
parameters:
161+
- name: favorite_gym_name
162+
in: query
163+
description: 行きつけのジム名
164+
required: true
165+
schema:
166+
type: string
167+
- name: store_name
168+
in: query
169+
description: 店舗名
170+
required: true
171+
schema:
172+
type: string
173+
- name: training_start_at
174+
in: query
175+
description: トレーニング開始
176+
schema:
177+
type: string
178+
- name: training_end_at
179+
in: query
180+
description: トレーニング終了時間
181+
schema:
182+
type: string
183+
- name: budget
184+
in: query
185+
description: 予算
186+
schema:
187+
type: number
188+
format: integer
189+
- name: training_menu_typ
190+
in: query
191+
description: トレーニングメニュー区分
192+
schema:
193+
type: number
194+
format: integer
195+
enum: [1, 2, 3]
160196
responses:
161197
'200':
162198
description: トレーナーの検索結果を取得しました。
@@ -291,7 +327,7 @@ paths:
291327
post:
292328
tags:
293329
- booking
294-
summary: API-013 トレーニング予約（仮登録）
330+
summary: API-012 トレーニング予約（仮登録）
295331
operationId: bookTraining
296332
requestBody:
297333
required: true
@@ -318,15 +354,32 @@ paths:
318354
get:
319355
tags:
320356
- booking
321-
summary: API-012 予約済みトレーニング取得
357+
summary: API-013 予約済みトレーニング取得
322358
operationId: getBookings
359+
parameters:
360+
- name: trainee_id
361+
in: path
362+
description: トレーニーID
363+
required: true
364+
schema:
365+
type: string
366+
- name: start_at
367+
in: query
368+
description: 開始日時
369+
schema:
370+
type: string
371+
- name: end_at
372+
in: query
373+
description: 終了日時
374+
schema:
375+
type: string
323376
responses:
324377
'200':
325378
description: ユーザーの予約情報を取得しました。
326379
content:
327380
application/json:
328381
schema:
329-
$ref: '#/components/schemas/Booking'
382+
$ref: '#/components/schemas/Bookings'
330383
'401':
331384
$ref: '#/components/responses/Unauthorized'
332385
'500':
@@ -741,6 +794,13 @@ components:
741794
self_introduction:
742795
type: string
743796
description: 自己紹介
797+
Bookings:
798+
type: object
799+
properties:
800+
bokkings:
801+
type: array
802+
items:
803+
$ref: '#/components/schemas/Booking'
744804
Booking:
745805
type: object
746806
properties:

‎documents/forMarkdown/future_muscle_partner/docs/README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@
77
```sh
88
docs
99
├── 01_画面 # Figma、画面アクション
10-
├── 02_WebAPI # api.yaml、API処理設計
11-
├── 03_データ # ERD、区分値
10+
├── 02_WebAPI # openapi.yaml、API処理設計
11+
├── 03_データ # erd.a5er（ERD）、区分値
1212
├── 04_IF # I/F定義＋受信/送信BL設計
1313
├── 05_バッチ # タイマー、イベント起動の非同期処理のBL設計
1414
├── 06_帳票 # 業務、システム担当者向けのレポート

0 commit comments

Comments
 (0)