@silbaram/artifact-driven-agent 0.1.9 → 0.2.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +296 -25
- package/ai-dev-team/.ada-status.template.json +10 -10
- package/ai-dev-team/README.md +39 -44
- package/ai-dev-team/artifacts/api.md +2 -212
- package/ai-dev-team/artifacts/features/_template/api.md +19 -19
- package/ai-dev-team/artifacts/features/_template/review.md +14 -14
- package/ai-dev-team/artifacts/features/_template/spec.md +28 -28
- package/ai-dev-team/artifacts/features/_template/ui.md +14 -14
- package/ai-dev-team/artifacts/improvement-reports/IMP-0000-template.md +57 -57
- package/ai-dev-team/artifacts/project.md +2 -193
- package/ai-dev-team/artifacts/rfc/RFC-0000-template.md +49 -49
- package/core/artifacts/decision.md +72 -72
- package/core/artifacts/plan.md +187 -187
- package/core/artifacts/project.md +193 -193
- package/core/artifacts/sprints/_template/docs/release-notes.md +37 -37
- package/core/artifacts/sprints/_template/meta.md +54 -54
- package/core/artifacts/sprints/_template/retrospective.md +50 -50
- package/core/artifacts/sprints/_template/review-reports/review-template.md +49 -49
- package/core/artifacts/sprints/_template/tasks/task-template.md +43 -43
- package/core/docs-templates/mkdocs/docs/architecture/overview.md +29 -29
- package/core/docs-templates/mkdocs/docs/changelog.md +36 -36
- package/core/docs-templates/mkdocs/docs/contributing/contributing.md +60 -60
- package/core/docs-templates/mkdocs/docs/getting-started/configuration.md +51 -51
- package/core/docs-templates/mkdocs/docs/getting-started/installation.md +41 -41
- package/core/docs-templates/mkdocs/docs/getting-started/quick-start.md +56 -56
- package/core/docs-templates/mkdocs/docs/guides/api-reference.md +83 -83
- package/core/docs-templates/mkdocs/docs/index.md +32 -32
- package/core/docs-templates/mkdocs/mkdocs.yml +86 -86
- package/core/roles/analyzer.md +265 -265
- package/core/roles/developer.md +6 -1
- package/core/roles/documenter.md +226 -715
- package/core/roles/improver.md +461 -461
- package/core/roles/manager.md +574 -544
- package/core/roles/planner.md +398 -398
- package/core/roles/reviewer.md +294 -294
- package/core/rules/document-priority.md +198 -198
- package/core/rules/escalation.md +172 -172
- package/core/rules/iteration.md +236 -236
- package/core/rules/rfc.md +31 -31
- package/core/rules/rollback.md +218 -218
- package/core/skills/_template/SKILL.md +50 -0
- package/core/skills/clean-code/SKILL.md +177 -0
- package/core/skills/code-review-checklist/SKILL.md +125 -0
- package/core/skills/error-handling/SKILL.md +155 -0
- package/core/skills/talk-game-dot-design/SKILL.md +85 -0
- package/core/skills/talk-game-dot-design/references/asset-specs.md +57 -0
- package/core/skills/talk-game-dot-design/references/review-checklist.md +34 -0
- package/core/skills/task-writing/SKILL.md +166 -0
- package/core/skills/testing-patterns/SKILL.md +140 -0
- package/dist/bin/cli.d.ts +2 -0
- package/dist/bin/cli.js +121 -0
- package/dist/bin/cli.js.map +1 -0
- package/dist/src/commands/config.d.ts +4 -0
- package/dist/src/commands/config.js +427 -0
- package/dist/src/commands/config.js.map +1 -0
- package/dist/src/commands/docs.d.ts +12 -0
- package/dist/src/commands/docs.js +453 -0
- package/dist/src/commands/docs.js.map +1 -0
- package/dist/src/commands/interactive.d.ts +4 -0
- package/dist/src/commands/interactive.js +380 -0
- package/dist/src/commands/interactive.js.map +1 -0
- package/dist/src/commands/logs.d.ts +1 -0
- package/dist/src/commands/logs.js +76 -0
- package/dist/src/commands/logs.js.map +1 -0
- package/dist/src/commands/monitor.d.ts +6 -0
- package/dist/src/commands/monitor.js +216 -0
- package/dist/src/commands/monitor.js.map +1 -0
- package/dist/src/commands/reset.d.ts +4 -0
- package/dist/src/commands/reset.js +57 -0
- package/dist/src/commands/reset.js.map +1 -0
- package/dist/src/commands/run.d.ts +45 -0
- package/dist/src/commands/run.js +421 -0
- package/dist/src/commands/run.js.map +1 -0
- package/dist/src/commands/sessions.d.ts +5 -0
- package/dist/src/commands/sessions.js +563 -0
- package/dist/src/commands/sessions.js.map +1 -0
- package/dist/src/commands/setup.d.ts +1 -0
- package/dist/src/commands/setup.js +132 -0
- package/dist/src/commands/setup.js.map +1 -0
- package/dist/src/commands/skills.d.ts +4 -0
- package/dist/src/commands/skills.js +748 -0
- package/dist/src/commands/skills.js.map +1 -0
- package/dist/src/commands/sprint.d.ts +4 -0
- package/dist/src/commands/sprint.js +434 -0
- package/dist/src/commands/sprint.js.map +1 -0
- package/dist/src/commands/status.d.ts +1 -0
- package/dist/src/commands/status.js +97 -0
- package/dist/src/commands/status.js.map +1 -0
- package/dist/src/commands/upgrade.d.ts +6 -0
- package/dist/src/commands/upgrade.js +350 -0
- package/dist/src/commands/upgrade.js.map +1 -0
- package/dist/src/commands/validate.d.ts +8 -0
- package/dist/src/commands/validate.js +260 -0
- package/dist/src/commands/validate.js.map +1 -0
- package/dist/src/commands/validate.test.d.ts +1 -0
- package/dist/src/commands/validate.test.js +74 -0
- package/dist/src/commands/validate.test.js.map +1 -0
- package/{src/index.js → dist/src/index.d.ts} +1 -3
- package/dist/src/index.js +15 -0
- package/dist/src/index.js.map +1 -0
- package/dist/src/types/common.d.ts +31 -0
- package/dist/src/types/common.js +2 -0
- package/dist/src/types/common.js.map +1 -0
- package/dist/src/types/config.d.ts +46 -0
- package/dist/src/types/config.js +2 -0
- package/dist/src/types/config.js.map +1 -0
- package/dist/src/types/index.d.ts +53 -0
- package/dist/src/types/index.js +2 -0
- package/dist/src/types/index.js.map +1 -0
- package/dist/src/types/session.d.ts +87 -0
- package/dist/src/types/session.js +2 -0
- package/dist/src/types/session.js.map +1 -0
- package/dist/src/types/task.d.ts +32 -0
- package/dist/src/types/task.js +2 -0
- package/dist/src/types/task.js.map +1 -0
- package/dist/src/ui/dashboard.d.ts +9 -0
- package/dist/src/ui/dashboard.js +468 -0
- package/dist/src/ui/dashboard.js.map +1 -0
- package/dist/src/ui/keyHandler.d.ts +47 -0
- package/dist/src/ui/keyHandler.js +132 -0
- package/dist/src/ui/keyHandler.js.map +1 -0
- package/dist/src/ui/quickActions.d.ts +25 -0
- package/dist/src/ui/quickActions.js +106 -0
- package/dist/src/ui/quickActions.js.map +1 -0
- package/dist/src/utils/config.d.ts +33 -0
- package/dist/src/utils/config.js +135 -0
- package/dist/src/utils/config.js.map +1 -0
- package/dist/src/utils/files.d.ts +84 -0
- package/dist/src/utils/files.js +202 -0
- package/dist/src/utils/files.js.map +1 -0
- package/dist/src/utils/promptBuilder.d.ts +39 -0
- package/dist/src/utils/promptBuilder.js +726 -0
- package/dist/src/utils/promptBuilder.js.map +1 -0
- package/dist/src/utils/sessionState.d.ts +83 -0
- package/dist/src/utils/sessionState.js +466 -0
- package/dist/src/utils/sessionState.js.map +1 -0
- package/dist/src/utils/sessionState.process.test.d.ts +1 -0
- package/dist/src/utils/sessionState.process.test.js +93 -0
- package/dist/src/utils/sessionState.process.test.js.map +1 -0
- package/dist/src/utils/sessionState.test.d.ts +1 -0
- package/dist/src/utils/sessionState.test.js +150 -0
- package/dist/src/utils/sessionState.test.js.map +1 -0
- package/dist/src/utils/sprintUtils.d.ts +13 -0
- package/dist/src/utils/sprintUtils.js +129 -0
- package/dist/src/utils/sprintUtils.js.map +1 -0
- package/dist/src/utils/taskParser.d.ts +9 -0
- package/dist/src/utils/taskParser.js +122 -0
- package/dist/src/utils/taskParser.js.map +1 -0
- package/dist/src/utils/taskParser.test.d.ts +1 -0
- package/dist/src/utils/taskParser.test.js +69 -0
- package/dist/src/utils/taskParser.test.js.map +1 -0
- package/package.json +62 -47
- package/templates/cli/artifacts/commands.md +262 -262
- package/templates/cli/artifacts/output-format.md +298 -298
- package/templates/cli/rules/command-change.md +225 -225
- package/templates/game/artifacts/assets.md +148 -148
- package/templates/game/artifacts/game-systems.md +217 -217
- package/templates/game/artifacts/hud.md +199 -199
- package/templates/game/rules/system-change.md +184 -184
- package/templates/library/artifacts/changelog.md +84 -84
- package/templates/library/artifacts/examples.md +157 -157
- package/templates/library/artifacts/public-api.md +197 -197
- package/templates/library/rules/versioning.md +186 -186
- package/templates/web-dev/artifacts/api.md +212 -212
- package/templates/web-dev/artifacts/ui.md +104 -104
- package/templates/web-dev/rules/api-change.md +198 -198
- package/ai-dev-team/.ada-status.json +0 -10
- package/ai-dev-team/.ada-version +0 -6
- package/ai-dev-team/.current-template +0 -1
- package/ai-dev-team/.gitkeep +0 -0
- package/ai-dev-team/.sessions/logs/20260124-014551-00f04724.log +0 -5
- package/ai-dev-team/.sessions/logs/20260124-014623-cb2b1d44.log +0 -5
- package/ai-dev-team/artifacts/.gitkeep +0 -0
- package/ai-dev-team/artifacts/decision.md +0 -72
- package/ai-dev-team/artifacts/plan.md +0 -187
- package/ai-dev-team/artifacts/sprints/_template/docs/release-notes.md +0 -37
- package/ai-dev-team/artifacts/sprints/_template/meta.md +0 -54
- package/ai-dev-team/artifacts/sprints/_template/retrospective.md +0 -50
- package/ai-dev-team/artifacts/sprints/_template/review-reports/review-template.md +0 -49
- package/ai-dev-team/artifacts/sprints/_template/tasks/task-template.md +0 -43
- package/ai-dev-team/artifacts/ui.md +0 -104
- package/ai-dev-team/roles/.gitkeep +0 -0
- package/ai-dev-team/roles/analyzer.md +0 -265
- package/ai-dev-team/roles/developer.md +0 -222
- package/ai-dev-team/roles/documenter.md +0 -715
- package/ai-dev-team/roles/improver.md +0 -461
- package/ai-dev-team/roles/manager.md +0 -544
- package/ai-dev-team/roles/planner.md +0 -398
- package/ai-dev-team/roles/reviewer.md +0 -294
- package/ai-dev-team/rules/.gitkeep +0 -0
- package/ai-dev-team/rules/api-change.md +0 -198
- package/ai-dev-team/rules/document-priority.md +0 -199
- package/ai-dev-team/rules/escalation.md +0 -172
- package/ai-dev-team/rules/iteration.md +0 -236
- package/ai-dev-team/rules/rfc.md +0 -31
- package/ai-dev-team/rules/rollback.md +0 -218
- package/bin/cli.js +0 -127
- package/src/commands/config.js +0 -371
- package/src/commands/docs.js +0 -502
- package/src/commands/interactive.js +0 -392
- package/src/commands/logs.js +0 -81
- package/src/commands/monitor.js +0 -236
- package/src/commands/reset.js +0 -66
- package/src/commands/run.js +0 -739
- package/src/commands/sessions.js +0 -646
- package/src/commands/setup.js +0 -149
- package/src/commands/sprint.js +0 -503
- package/src/commands/status.js +0 -109
- package/src/commands/upgrade.js +0 -416
- package/src/commands/validate.js +0 -289
- package/src/commands/validate.test.js +0 -84
- package/src/ui/dashboard.js +0 -518
- package/src/ui/keyHandler.js +0 -147
- package/src/ui/quickActions.js +0 -111
- package/src/utils/config.js +0 -74
- package/src/utils/files.js +0 -201
- package/src/utils/sessionState.js +0 -513
- package/src/utils/sessionState.process.test.js +0 -101
- package/src/utils/sessionState.test.js +0 -183
- package/src/utils/sprintUtils.js +0 -134
- package/src/utils/taskParser.js +0 -134
- package/src/utils/taskParser.test.js +0 -76
|
@@ -1,212 +1,212 @@
|
|
|
1
|
-
# API Specification
|
|
2
|
-
|
|
3
|
-
> Backend와 Frontend의 공식 계약 문서
|
|
4
|
-
> 변경 시 rules/api-change.md 절차를 따른다
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 0. 문서 메타
|
|
9
|
-
|
|
10
|
-
| 항목 | 값 |
|
|
11
|
-
|------|-----|
|
|
12
|
-
| 버전 | v1.0 |
|
|
13
|
-
| Base URL | /api/v1 |
|
|
14
|
-
| 최종 수정 | YYYY-MM-DD |
|
|
15
|
-
|
|
16
|
-
---
|
|
17
|
-
|
|
18
|
-
## 1. 공통 규칙
|
|
19
|
-
|
|
20
|
-
### 1.1 HTTP 메서드
|
|
21
|
-
|
|
22
|
-
| 메서드 | 용도 | 멱등성 |
|
|
23
|
-
|--------|------|:------:|
|
|
24
|
-
| GET | 조회 | ✅ |
|
|
25
|
-
| POST | 생성 | ❌ |
|
|
26
|
-
| PUT | 전체 수정 | ✅ |
|
|
27
|
-
| PATCH | 부분 수정 | ❌ |
|
|
28
|
-
| DELETE | 삭제 | ✅ |
|
|
29
|
-
|
|
30
|
-
### 1.2 경로 규칙
|
|
31
|
-
|
|
32
|
-
- 리소스명: 복수형 소문자 (예: `/users`, `/posts`)
|
|
33
|
-
- 단일 리소스: `/{resource}/{id}`
|
|
34
|
-
- 중첩 리소스: `/{parent}/{parentId}/{child}`
|
|
35
|
-
|
|
36
|
-
---
|
|
37
|
-
|
|
38
|
-
## 2. 인증/권한
|
|
39
|
-
|
|
40
|
-
| 항목 | 값 |
|
|
41
|
-
|------|-----|
|
|
42
|
-
| Status | 사용 / 미사용 |
|
|
43
|
-
| Scheme | Bearer Token / Cookie / API Key |
|
|
44
|
-
| Token Location | Authorization: Bearer {token} |
|
|
45
|
-
|
|
46
|
-
---
|
|
47
|
-
|
|
48
|
-
## 3. 응답 규격 (Response Envelope)
|
|
49
|
-
|
|
50
|
-
### 3.1 Success Response
|
|
51
|
-
|
|
52
|
-
```json
|
|
53
|
-
{
|
|
54
|
-
"success": true,
|
|
55
|
-
"data": { },
|
|
56
|
-
"error": null,
|
|
57
|
-
"meta": {
|
|
58
|
-
"requestId": "uuid",
|
|
59
|
-
"timestamp": "2024-01-01T00:00:00Z"
|
|
60
|
-
}
|
|
61
|
-
}
|
|
62
|
-
```
|
|
63
|
-
|
|
64
|
-
### 3.2 Failure Response
|
|
65
|
-
|
|
66
|
-
```json
|
|
67
|
-
{
|
|
68
|
-
"success": false,
|
|
69
|
-
"data": null,
|
|
70
|
-
"error": {
|
|
71
|
-
"code": "ERROR_CODE",
|
|
72
|
-
"message": "사용자에게 표시할 메시지",
|
|
73
|
-
"details": { }
|
|
74
|
-
},
|
|
75
|
-
"meta": {
|
|
76
|
-
"requestId": "uuid",
|
|
77
|
-
"timestamp": "2024-01-01T00:00:00Z"
|
|
78
|
-
}
|
|
79
|
-
}
|
|
80
|
-
```
|
|
81
|
-
|
|
82
|
-
---
|
|
83
|
-
|
|
84
|
-
## 4. 공통 에러 코드
|
|
85
|
-
|
|
86
|
-
| HTTP | 에러 코드 | 설명 |
|
|
87
|
-
|------|----------|------|
|
|
88
|
-
| 400 | BAD_REQUEST | 잘못된 요청 |
|
|
89
|
-
| 400 | VALIDATION_ERROR | 유효성 검사 실패 |
|
|
90
|
-
| 401 | UNAUTHORIZED | 인증 필요 |
|
|
91
|
-
| 403 | FORBIDDEN | 권한 없음 |
|
|
92
|
-
| 404 | NOT_FOUND | 리소스 없음 |
|
|
93
|
-
| 409 | CONFLICT | 충돌 |
|
|
94
|
-
| 500 | INTERNAL_ERROR | 서버 오류 |
|
|
95
|
-
|
|
96
|
-
---
|
|
97
|
-
|
|
98
|
-
## 5. 페이지네이션
|
|
99
|
-
|
|
100
|
-
### Request
|
|
101
|
-
|
|
102
|
-
```
|
|
103
|
-
GET /resources?page=1&size=20&sort=createdAt,desc
|
|
104
|
-
```
|
|
105
|
-
|
|
106
|
-
### Response
|
|
107
|
-
|
|
108
|
-
```json
|
|
109
|
-
{
|
|
110
|
-
"success": true,
|
|
111
|
-
"data": {
|
|
112
|
-
"content": [...],
|
|
113
|
-
"page": {
|
|
114
|
-
"number": 1,
|
|
115
|
-
"size": 20,
|
|
116
|
-
"totalElements": 100,
|
|
117
|
-
"totalPages": 5
|
|
118
|
-
}
|
|
119
|
-
}
|
|
120
|
-
}
|
|
121
|
-
```
|
|
122
|
-
|
|
123
|
-
---
|
|
124
|
-
|
|
125
|
-
## 6. API 엔드포인트 정의
|
|
126
|
-
|
|
127
|
-
### 6.1 [리소스명]
|
|
128
|
-
|
|
129
|
-
#### GET /resources
|
|
130
|
-
|
|
131
|
-
**설명:** 목록 조회
|
|
132
|
-
|
|
133
|
-
**Request:**
|
|
134
|
-
```
|
|
135
|
-
Query Parameters:
|
|
136
|
-
- page: number (default: 1)
|
|
137
|
-
- size: number (default: 20)
|
|
138
|
-
```
|
|
139
|
-
|
|
140
|
-
**Response (200):**
|
|
141
|
-
```json
|
|
142
|
-
{
|
|
143
|
-
"success": true,
|
|
144
|
-
"data": {
|
|
145
|
-
"content": [
|
|
146
|
-
{
|
|
147
|
-
"id": "uuid",
|
|
148
|
-
"name": "string",
|
|
149
|
-
"createdAt": "datetime"
|
|
150
|
-
}
|
|
151
|
-
],
|
|
152
|
-
"page": { ... }
|
|
153
|
-
}
|
|
154
|
-
}
|
|
155
|
-
```
|
|
156
|
-
|
|
157
|
-
**에러:**
|
|
158
|
-
| 상황 | 코드 |
|
|
159
|
-
|------|------|
|
|
160
|
-
| 잘못된 파라미터 | BAD_REQUEST |
|
|
161
|
-
|
|
162
|
-
---
|
|
163
|
-
|
|
164
|
-
#### POST /resources
|
|
165
|
-
|
|
166
|
-
**설명:** 생성
|
|
167
|
-
|
|
168
|
-
**Request:**
|
|
169
|
-
```json
|
|
170
|
-
{
|
|
171
|
-
"name": "string (required)",
|
|
172
|
-
"description": "string (optional)"
|
|
173
|
-
}
|
|
174
|
-
```
|
|
175
|
-
|
|
176
|
-
**Response (201):**
|
|
177
|
-
```json
|
|
178
|
-
{
|
|
179
|
-
"success": true,
|
|
180
|
-
"data": {
|
|
181
|
-
"id": "uuid",
|
|
182
|
-
"name": "string",
|
|
183
|
-
"createdAt": "datetime"
|
|
184
|
-
}
|
|
185
|
-
}
|
|
186
|
-
```
|
|
187
|
-
|
|
188
|
-
**에러:**
|
|
189
|
-
| 상황 | 코드 |
|
|
190
|
-
|------|------|
|
|
191
|
-
| 필수 필드 누락 | VALIDATION_ERROR |
|
|
192
|
-
| 중복 | CONFLICT |
|
|
193
|
-
|
|
194
|
-
---
|
|
195
|
-
|
|
196
|
-
## 7. API 목록 요약
|
|
197
|
-
|
|
198
|
-
| 메서드 | 경로 | 설명 | 상태 | Task |
|
|
199
|
-
|--------|------|------|:----:|------|
|
|
200
|
-
| GET | /resources | 목록 조회 | ✅ | TASK-001 |
|
|
201
|
-
| POST | /resources | 생성 | ⏳ | TASK-001 |
|
|
202
|
-
| GET | /resources/{id} | 단일 조회 | 📋 | TASK-002 |
|
|
203
|
-
|
|
204
|
-
상태: ✅ 완료 / ⏳ 진행중 / 📋 예정
|
|
205
|
-
|
|
206
|
-
---
|
|
207
|
-
|
|
208
|
-
## 8. 변경 이력
|
|
209
|
-
|
|
210
|
-
| Task | 날짜 | 변경 내용 |
|
|
211
|
-
|------|------|----------|
|
|
212
|
-
| [TASK-001] | YYYY-MM-DD | 초기 API 작성 |
|
|
1
|
+
# API Specification
|
|
2
|
+
|
|
3
|
+
> Backend와 Frontend의 공식 계약 문서
|
|
4
|
+
> 변경 시 rules/api-change.md 절차를 따른다
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 0. 문서 메타
|
|
9
|
+
|
|
10
|
+
| 항목 | 값 |
|
|
11
|
+
|------|-----|
|
|
12
|
+
| 버전 | v1.0 |
|
|
13
|
+
| Base URL | /api/v1 |
|
|
14
|
+
| 최종 수정 | YYYY-MM-DD |
|
|
15
|
+
|
|
16
|
+
---
|
|
17
|
+
|
|
18
|
+
## 1. 공통 규칙
|
|
19
|
+
|
|
20
|
+
### 1.1 HTTP 메서드
|
|
21
|
+
|
|
22
|
+
| 메서드 | 용도 | 멱등성 |
|
|
23
|
+
|--------|------|:------:|
|
|
24
|
+
| GET | 조회 | ✅ |
|
|
25
|
+
| POST | 생성 | ❌ |
|
|
26
|
+
| PUT | 전체 수정 | ✅ |
|
|
27
|
+
| PATCH | 부분 수정 | ❌ |
|
|
28
|
+
| DELETE | 삭제 | ✅ |
|
|
29
|
+
|
|
30
|
+
### 1.2 경로 규칙
|
|
31
|
+
|
|
32
|
+
- 리소스명: 복수형 소문자 (예: `/users`, `/posts`)
|
|
33
|
+
- 단일 리소스: `/{resource}/{id}`
|
|
34
|
+
- 중첩 리소스: `/{parent}/{parentId}/{child}`
|
|
35
|
+
|
|
36
|
+
---
|
|
37
|
+
|
|
38
|
+
## 2. 인증/권한
|
|
39
|
+
|
|
40
|
+
| 항목 | 값 |
|
|
41
|
+
|------|-----|
|
|
42
|
+
| Status | 사용 / 미사용 |
|
|
43
|
+
| Scheme | Bearer Token / Cookie / API Key |
|
|
44
|
+
| Token Location | Authorization: Bearer {token} |
|
|
45
|
+
|
|
46
|
+
---
|
|
47
|
+
|
|
48
|
+
## 3. 응답 규격 (Response Envelope)
|
|
49
|
+
|
|
50
|
+
### 3.1 Success Response
|
|
51
|
+
|
|
52
|
+
```json
|
|
53
|
+
{
|
|
54
|
+
"success": true,
|
|
55
|
+
"data": { },
|
|
56
|
+
"error": null,
|
|
57
|
+
"meta": {
|
|
58
|
+
"requestId": "uuid",
|
|
59
|
+
"timestamp": "2024-01-01T00:00:00Z"
|
|
60
|
+
}
|
|
61
|
+
}
|
|
62
|
+
```
|
|
63
|
+
|
|
64
|
+
### 3.2 Failure Response
|
|
65
|
+
|
|
66
|
+
```json
|
|
67
|
+
{
|
|
68
|
+
"success": false,
|
|
69
|
+
"data": null,
|
|
70
|
+
"error": {
|
|
71
|
+
"code": "ERROR_CODE",
|
|
72
|
+
"message": "사용자에게 표시할 메시지",
|
|
73
|
+
"details": { }
|
|
74
|
+
},
|
|
75
|
+
"meta": {
|
|
76
|
+
"requestId": "uuid",
|
|
77
|
+
"timestamp": "2024-01-01T00:00:00Z"
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
```
|
|
81
|
+
|
|
82
|
+
---
|
|
83
|
+
|
|
84
|
+
## 4. 공통 에러 코드
|
|
85
|
+
|
|
86
|
+
| HTTP | 에러 코드 | 설명 |
|
|
87
|
+
|------|----------|------|
|
|
88
|
+
| 400 | BAD_REQUEST | 잘못된 요청 |
|
|
89
|
+
| 400 | VALIDATION_ERROR | 유효성 검사 실패 |
|
|
90
|
+
| 401 | UNAUTHORIZED | 인증 필요 |
|
|
91
|
+
| 403 | FORBIDDEN | 권한 없음 |
|
|
92
|
+
| 404 | NOT_FOUND | 리소스 없음 |
|
|
93
|
+
| 409 | CONFLICT | 충돌 |
|
|
94
|
+
| 500 | INTERNAL_ERROR | 서버 오류 |
|
|
95
|
+
|
|
96
|
+
---
|
|
97
|
+
|
|
98
|
+
## 5. 페이지네이션
|
|
99
|
+
|
|
100
|
+
### Request
|
|
101
|
+
|
|
102
|
+
```
|
|
103
|
+
GET /resources?page=1&size=20&sort=createdAt,desc
|
|
104
|
+
```
|
|
105
|
+
|
|
106
|
+
### Response
|
|
107
|
+
|
|
108
|
+
```json
|
|
109
|
+
{
|
|
110
|
+
"success": true,
|
|
111
|
+
"data": {
|
|
112
|
+
"content": [...],
|
|
113
|
+
"page": {
|
|
114
|
+
"number": 1,
|
|
115
|
+
"size": 20,
|
|
116
|
+
"totalElements": 100,
|
|
117
|
+
"totalPages": 5
|
|
118
|
+
}
|
|
119
|
+
}
|
|
120
|
+
}
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
---
|
|
124
|
+
|
|
125
|
+
## 6. API 엔드포인트 정의
|
|
126
|
+
|
|
127
|
+
### 6.1 [리소스명]
|
|
128
|
+
|
|
129
|
+
#### GET /resources
|
|
130
|
+
|
|
131
|
+
**설명:** 목록 조회
|
|
132
|
+
|
|
133
|
+
**Request:**
|
|
134
|
+
```
|
|
135
|
+
Query Parameters:
|
|
136
|
+
- page: number (default: 1)
|
|
137
|
+
- size: number (default: 20)
|
|
138
|
+
```
|
|
139
|
+
|
|
140
|
+
**Response (200):**
|
|
141
|
+
```json
|
|
142
|
+
{
|
|
143
|
+
"success": true,
|
|
144
|
+
"data": {
|
|
145
|
+
"content": [
|
|
146
|
+
{
|
|
147
|
+
"id": "uuid",
|
|
148
|
+
"name": "string",
|
|
149
|
+
"createdAt": "datetime"
|
|
150
|
+
}
|
|
151
|
+
],
|
|
152
|
+
"page": { ... }
|
|
153
|
+
}
|
|
154
|
+
}
|
|
155
|
+
```
|
|
156
|
+
|
|
157
|
+
**에러:**
|
|
158
|
+
| 상황 | 코드 |
|
|
159
|
+
|------|------|
|
|
160
|
+
| 잘못된 파라미터 | BAD_REQUEST |
|
|
161
|
+
|
|
162
|
+
---
|
|
163
|
+
|
|
164
|
+
#### POST /resources
|
|
165
|
+
|
|
166
|
+
**설명:** 생성
|
|
167
|
+
|
|
168
|
+
**Request:**
|
|
169
|
+
```json
|
|
170
|
+
{
|
|
171
|
+
"name": "string (required)",
|
|
172
|
+
"description": "string (optional)"
|
|
173
|
+
}
|
|
174
|
+
```
|
|
175
|
+
|
|
176
|
+
**Response (201):**
|
|
177
|
+
```json
|
|
178
|
+
{
|
|
179
|
+
"success": true,
|
|
180
|
+
"data": {
|
|
181
|
+
"id": "uuid",
|
|
182
|
+
"name": "string",
|
|
183
|
+
"createdAt": "datetime"
|
|
184
|
+
}
|
|
185
|
+
}
|
|
186
|
+
```
|
|
187
|
+
|
|
188
|
+
**에러:**
|
|
189
|
+
| 상황 | 코드 |
|
|
190
|
+
|------|------|
|
|
191
|
+
| 필수 필드 누락 | VALIDATION_ERROR |
|
|
192
|
+
| 중복 | CONFLICT |
|
|
193
|
+
|
|
194
|
+
---
|
|
195
|
+
|
|
196
|
+
## 7. API 목록 요약
|
|
197
|
+
|
|
198
|
+
| 메서드 | 경로 | 설명 | 상태 | Task |
|
|
199
|
+
|--------|------|------|:----:|------|
|
|
200
|
+
| GET | /resources | 목록 조회 | ✅ | TASK-001 |
|
|
201
|
+
| POST | /resources | 생성 | ⏳ | TASK-001 |
|
|
202
|
+
| GET | /resources/{id} | 단일 조회 | 📋 | TASK-002 |
|
|
203
|
+
|
|
204
|
+
상태: ✅ 완료 / ⏳ 진행중 / 📋 예정
|
|
205
|
+
|
|
206
|
+
---
|
|
207
|
+
|
|
208
|
+
## 8. 변경 이력
|
|
209
|
+
|
|
210
|
+
| Task | 날짜 | 변경 내용 |
|
|
211
|
+
|------|------|----------|
|
|
212
|
+
| [TASK-001] | YYYY-MM-DD | 초기 API 작성 |
|
|
@@ -1,104 +1,104 @@
|
|
|
1
|
-
# UI Specification
|
|
2
|
-
|
|
3
|
-
> 프론트엔드 화면 설계 문서
|
|
4
|
-
> plan.md 사용자 흐름과 api.md 연동 기준
|
|
5
|
-
|
|
6
|
-
---
|
|
7
|
-
|
|
8
|
-
## 0. 문서 메타
|
|
9
|
-
|
|
10
|
-
| 항목 | 값 |
|
|
11
|
-
|------|-----|
|
|
12
|
-
| 버전 | v1.0 |
|
|
13
|
-
| 최종 수정 | YYYY-MM-DD |
|
|
14
|
-
|
|
15
|
-
---
|
|
16
|
-
|
|
17
|
-
## 1. 라우팅 구조
|
|
18
|
-
|
|
19
|
-
| 경로 | 화면명 | 설명 | 상태 | Task |
|
|
20
|
-
|------|--------|------|:----:|------|
|
|
21
|
-
| / | 홈 | 메인 화면 | ✅ | TASK-001 |
|
|
22
|
-
| /list | 목록 | 목록 화면 | ⏳ | TASK-002 |
|
|
23
|
-
| /detail/:id | 상세 | 상세 화면 | 📋 | TASK-003 |
|
|
24
|
-
|
|
25
|
-
상태: ✅ 완료 / ⏳ 진행중 / 📋 예정
|
|
26
|
-
|
|
27
|
-
---
|
|
28
|
-
|
|
29
|
-
## 2. 화면별 상태 정의 (필수)
|
|
30
|
-
|
|
31
|
-
### 2.1 [화면명]: /path
|
|
32
|
-
|
|
33
|
-
#### API 연동
|
|
34
|
-
|
|
35
|
-
| API | 용도 | 상태 |
|
|
36
|
-
|-----|------|------|
|
|
37
|
-
| GET /resources | 데이터 조회 | 연동 |
|
|
38
|
-
|
|
39
|
-
#### 화면 상태
|
|
40
|
-
|
|
41
|
-
| 상태 | 조건 | 표시 |
|
|
42
|
-
|------|------|------|
|
|
43
|
-
| Loading | API 호출 중 | 로딩 스피너 |
|
|
44
|
-
| Empty | data.length === 0 | "데이터가 없습니다" |
|
|
45
|
-
| Error | API 실패 | 에러 메시지 + 재시도 |
|
|
46
|
-
| Success | data.length > 0 | 데이터 목록 |
|
|
47
|
-
|
|
48
|
-
#### 사용자 액션
|
|
49
|
-
|
|
50
|
-
| 액션 | 트리거 | 결과 |
|
|
51
|
-
|------|--------|------|
|
|
52
|
-
| 새로고침 | 버튼 클릭 | 목록 재조회 |
|
|
53
|
-
| 항목 클릭 | 목록 아이템 | 상세 화면 이동 |
|
|
54
|
-
|
|
55
|
-
---
|
|
56
|
-
|
|
57
|
-
### 2.2 [화면명]: /path
|
|
58
|
-
|
|
59
|
-
(동일 형식으로 작성)
|
|
60
|
-
|
|
61
|
-
---
|
|
62
|
-
|
|
63
|
-
## 3. API 연동 매핑
|
|
64
|
-
|
|
65
|
-
| 화면 | API | 상태 관리 |
|
|
66
|
-
|------|-----|----------|
|
|
67
|
-
| 목록 | GET /resources | 로컬 |
|
|
68
|
-
| 상세 | GET /resources/{id} | 로컬 |
|
|
69
|
-
| 생성 폼 | POST /resources | 로컬 |
|
|
70
|
-
|
|
71
|
-
---
|
|
72
|
-
|
|
73
|
-
## 4. 컴포넌트 구조 (요약)
|
|
74
|
-
|
|
75
|
-
```
|
|
76
|
-
src/
|
|
77
|
-
├── pages/
|
|
78
|
-
│ ├── HomePage/
|
|
79
|
-
│ ├── ListPage/
|
|
80
|
-
│ └── DetailPage/
|
|
81
|
-
├── components/
|
|
82
|
-
│ ├── common/
|
|
83
|
-
│ └── [feature]/
|
|
84
|
-
└── hooks/
|
|
85
|
-
└── [feature]/
|
|
86
|
-
```
|
|
87
|
-
|
|
88
|
-
---
|
|
89
|
-
|
|
90
|
-
## 5. 공통 컴포넌트
|
|
91
|
-
|
|
92
|
-
| 컴포넌트 | 용도 | Props |
|
|
93
|
-
|----------|------|-------|
|
|
94
|
-
| Loading | 로딩 표시 | - |
|
|
95
|
-
| Empty | 빈 상태 | message |
|
|
96
|
-
| Error | 에러 표시 | message, onRetry |
|
|
97
|
-
|
|
98
|
-
---
|
|
99
|
-
|
|
100
|
-
## 6. 변경 이력
|
|
101
|
-
|
|
102
|
-
| Task | 날짜 | 변경 내용 |
|
|
103
|
-
|------|------|----------|
|
|
104
|
-
| [TASK-002] | YYYY-MM-DD | 목록 화면 추가 |
|
|
1
|
+
# UI Specification
|
|
2
|
+
|
|
3
|
+
> 프론트엔드 화면 설계 문서
|
|
4
|
+
> plan.md 사용자 흐름과 api.md 연동 기준
|
|
5
|
+
|
|
6
|
+
---
|
|
7
|
+
|
|
8
|
+
## 0. 문서 메타
|
|
9
|
+
|
|
10
|
+
| 항목 | 값 |
|
|
11
|
+
|------|-----|
|
|
12
|
+
| 버전 | v1.0 |
|
|
13
|
+
| 최종 수정 | YYYY-MM-DD |
|
|
14
|
+
|
|
15
|
+
---
|
|
16
|
+
|
|
17
|
+
## 1. 라우팅 구조
|
|
18
|
+
|
|
19
|
+
| 경로 | 화면명 | 설명 | 상태 | Task |
|
|
20
|
+
|------|--------|------|:----:|------|
|
|
21
|
+
| / | 홈 | 메인 화면 | ✅ | TASK-001 |
|
|
22
|
+
| /list | 목록 | 목록 화면 | ⏳ | TASK-002 |
|
|
23
|
+
| /detail/:id | 상세 | 상세 화면 | 📋 | TASK-003 |
|
|
24
|
+
|
|
25
|
+
상태: ✅ 완료 / ⏳ 진행중 / 📋 예정
|
|
26
|
+
|
|
27
|
+
---
|
|
28
|
+
|
|
29
|
+
## 2. 화면별 상태 정의 (필수)
|
|
30
|
+
|
|
31
|
+
### 2.1 [화면명]: /path
|
|
32
|
+
|
|
33
|
+
#### API 연동
|
|
34
|
+
|
|
35
|
+
| API | 용도 | 상태 |
|
|
36
|
+
|-----|------|------|
|
|
37
|
+
| GET /resources | 데이터 조회 | 연동 |
|
|
38
|
+
|
|
39
|
+
#### 화면 상태
|
|
40
|
+
|
|
41
|
+
| 상태 | 조건 | 표시 |
|
|
42
|
+
|------|------|------|
|
|
43
|
+
| Loading | API 호출 중 | 로딩 스피너 |
|
|
44
|
+
| Empty | data.length === 0 | "데이터가 없습니다" |
|
|
45
|
+
| Error | API 실패 | 에러 메시지 + 재시도 |
|
|
46
|
+
| Success | data.length > 0 | 데이터 목록 |
|
|
47
|
+
|
|
48
|
+
#### 사용자 액션
|
|
49
|
+
|
|
50
|
+
| 액션 | 트리거 | 결과 |
|
|
51
|
+
|------|--------|------|
|
|
52
|
+
| 새로고침 | 버튼 클릭 | 목록 재조회 |
|
|
53
|
+
| 항목 클릭 | 목록 아이템 | 상세 화면 이동 |
|
|
54
|
+
|
|
55
|
+
---
|
|
56
|
+
|
|
57
|
+
### 2.2 [화면명]: /path
|
|
58
|
+
|
|
59
|
+
(동일 형식으로 작성)
|
|
60
|
+
|
|
61
|
+
---
|
|
62
|
+
|
|
63
|
+
## 3. API 연동 매핑
|
|
64
|
+
|
|
65
|
+
| 화면 | API | 상태 관리 |
|
|
66
|
+
|------|-----|----------|
|
|
67
|
+
| 목록 | GET /resources | 로컬 |
|
|
68
|
+
| 상세 | GET /resources/{id} | 로컬 |
|
|
69
|
+
| 생성 폼 | POST /resources | 로컬 |
|
|
70
|
+
|
|
71
|
+
---
|
|
72
|
+
|
|
73
|
+
## 4. 컴포넌트 구조 (요약)
|
|
74
|
+
|
|
75
|
+
```
|
|
76
|
+
src/
|
|
77
|
+
├── pages/
|
|
78
|
+
│ ├── HomePage/
|
|
79
|
+
│ ├── ListPage/
|
|
80
|
+
│ └── DetailPage/
|
|
81
|
+
├── components/
|
|
82
|
+
│ ├── common/
|
|
83
|
+
│ └── [feature]/
|
|
84
|
+
└── hooks/
|
|
85
|
+
└── [feature]/
|
|
86
|
+
```
|
|
87
|
+
|
|
88
|
+
---
|
|
89
|
+
|
|
90
|
+
## 5. 공통 컴포넌트
|
|
91
|
+
|
|
92
|
+
| 컴포넌트 | 용도 | Props |
|
|
93
|
+
|----------|------|-------|
|
|
94
|
+
| Loading | 로딩 표시 | - |
|
|
95
|
+
| Empty | 빈 상태 | message |
|
|
96
|
+
| Error | 에러 표시 | message, onRetry |
|
|
97
|
+
|
|
98
|
+
---
|
|
99
|
+
|
|
100
|
+
## 6. 변경 이력
|
|
101
|
+
|
|
102
|
+
| Task | 날짜 | 변경 내용 |
|
|
103
|
+
|------|------|----------|
|
|
104
|
+
| [TASK-002] | YYYY-MM-DD | 목록 화면 추가 |
|