Skip to content

Commit 228b6ae

Browse files
salieri009salieri009
committed
documentaiton fix
1 parent 3b9de94 commit 228b6ae

141 files changed

Lines changed: 3535 additions & 362 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/0_refactoring/PHASE_1_SUMMARY.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -368,3 +368,9 @@ docs/8_archive/*
368368
**Status**: Published
369369
**Document Purpose**: Phase 1 Completion Summary
370370

371+
372+
373+
---
374+
375+
**Document Version**: 1.0.0
376+
**Maintained By**: IoT Bay Documentation Team

‎docs/0_refactoring/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,3 +94,8 @@ docs/
9494
**Status**: In Progress
9595
**Last Updated**: December 3, 2025
9696
**Maintained By**: IoT Bay Documentation Team
97+
98+
99+
---
100+
101+
**Document Version**: 1.0.0

‎docs/1_getting-started/PROJECT_OVERVIEW.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,3 +196,11 @@ docs/
196196
**Last Updated**: December 3, 2025
197197
**Version**: 1.0.0
198198
**Next Steps**: [Quick Start Guide](./QUICKSTART.md)
199+
200+
201+
---
202+
203+
**Document Version**: 1.0.0
204+
**Status**: Published
205+
**Audience**: Developers, Stakeholders
206+
**Maintained By**: IoT Bay Documentation Team

‎docs/1_getting-started/QUICKSTART.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -122,3 +122,11 @@ For detailed setup including IDE configuration, database setup, and troubleshoot
122122
---
123123

124124
**Last Updated**: December 3, 2025
125+
126+
127+
---
128+
129+
**Document Version**: 1.0.0
130+
**Status**: Published
131+
**Audience**: Developers, Stakeholders
132+
**Maintained By**: IoT Bay Documentation Team

‎docs/1_getting-started/README.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,3 +103,8 @@ A: See [Contributing Guidelines](../4_development/CONTRIBUTING.md).
103103
**Status**: Published
104104
**Last Updated**: December 3, 2025
105105
**Maintained By**: IoT Bay Documentation Team
106+
107+
108+
---
109+
110+
**Document Version**: 1.0.0

‎docs/1_getting-started/SETUP_GUIDE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -290,3 +290,11 @@ You'll know setup is successful when:
290290

291291
**Last Updated**: December 3, 2025
292292
**Version**: 1.0.0
293+
294+
295+
---
296+
297+
**Document Version**: 1.0.0
298+
**Status**: Published
299+
**Audience**: Developers, Stakeholders
300+
**Maintained By**: IoT Bay Documentation Team

‎docs/1_getting-started/TECH_STACK.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,3 +267,11 @@ View complete list in `pom.xml` file.
267267

268268
**Last Updated**: December 3, 2025
269269
**Version**: 1.0.0
270+
271+
272+
---
273+
274+
**Document Version**: 1.0.0
275+
**Status**: Published
276+
**Audience**: Developers, Stakeholders
277+
**Maintained By**: IoT Bay Documentation Team

‎docs/2_architecture/API_DESIGN.md‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
# API Design
2+
3+
**Document Version**: 1.0.0
4+
**Status**: Published
5+
**Last Updated**: December 3, 2025
6+
**Audience**: Architects, Developers
7+
**Maintained By**: IoT Bay Documentation Team
8+
9+
---
10+
11+
## Overview
12+
13+
IoT Bay uses a RESTful API design pattern for client-server communication, primarily serving the frontend JSP pages via AJAX and providing potential external integration points.
14+
15+
## Design Principles
16+
17+
1. **Resource-Oriented**: URLs represent resources (e.g., `/api/products`, `/api/users`).
18+
2. **Stateless**: Each request contains all necessary information (via session cookies).
19+
3. **Standard Methods**: Uses HTTP methods explicitly (GET, POST, PUT, DELETE).
20+
4. **JSON Format**: Data exchange in JSON format.
21+
22+
## API Structure
23+
24+
### Base URL
25+
- Development: `http://localhost:8080/IoTBay/api`
26+
- Production: `https://iotbay.com/api`
27+
28+
### Standard Response Format
29+
30+
```json
31+
{
32+
"success": true,
33+
"data": { ... },
34+
"message": "Operation successful",
35+
"timestamp": "2025-12-03T12:00:00Z"
36+
}
37+
```
38+
39+
### Error Format
40+
41+
```json
42+
{
43+
"success": false,
44+
"error": "RESOURCE_NOT_FOUND",
45+
"message": "The requested product ID 123 does not exist",
46+
"statusCode": 404
47+
}
48+
```
49+
50+
## Core Resources
51+
52+
| Resource | Description | Endpoint |
53+
|---|---|---|
54+
| **Auth** | Login, register, logout | `/auth/*` |
55+
| **Products** | Catalog management | `/products/*` |
56+
| **Orders** | Order processing | `/orders/*` |
57+
| **Users** | Profile management | `/users/*` |
58+
59+
## Detailed Documentation
60+
61+
For the complete list of endpoints, parameters, and examples, please refer to the **[API Reference](../3_requirements/API_REFERENCE.md)**.
62+
63+
## Related Documentation
64+
65+
- [API Reference](../3_requirements/API_REFERENCE.md)
66+
- [Backend Guide](../4_development/BACKEND_GUIDE.md)

‎docs/2_architecture/COMPONENT_ARCHITECTURE.en_docs.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1159,3 +1159,12 @@ export const AllSizes: Story = {
11591159
---
11601160

11611161
이 컴포넌트 아키텍처는 확장성, 재사용성, 유지보수성을 핵심으로 하여 IoTBay 프로젝트의 장기적인 성장을 지원합니다. 각 컴포넌트는 명확한 책임을 가지며, 타입 안전성과 성능 최적화를 통해 안정적인 사용자 경험을 제공합니다.
1162+
1163+
1164+
---
1165+
1166+
**Document Version**: 1.0.0
1167+
**Status**: Published
1168+
**Last Updated**: 12�� 3, 2025
1169+
**Audience**: Developers, Stakeholders
1170+
**Maintained By**: IoT Bay Documentation Team

‎docs/2_architecture/COMPONENT_ARCHITECTURE.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,3 +225,11 @@ Before committing a new component:
225225

226226
**Last Updated**: December 3, 2025
227227
**Version**: 1.0.0
228+
229+
230+
---
231+
232+
**Document Version**: 1.0.0
233+
**Status**: Published
234+
**Audience**: Developers, Stakeholders
235+
**Maintained By**: IoT Bay Documentation Team

0 commit comments

Comments
 (0)