55 lines
1.8 KiB
Markdown
55 lines
1.8 KiB
Markdown
# API 프로젝트 문서
|
|
|
|
> API 구성 및 설정에 관한 문서만 포함합니다.
|
|
> 프로젝트 관련 문서는 `/SAM/docs/`를 참조하세요.
|
|
|
|
---
|
|
|
|
## 📋 Swagger 문서
|
|
|
|
API 엔드포인트별 Swagger 스펙 문서입니다.
|
|
|
|
- **[Audit Log API](swagger/SWAGGER_AUDIT.md)** - 감사 로그 API 스펙
|
|
- **[Product API](swagger/SWAGGER_PHASE3_1_PRODUCT.md)** - 제품 관리 API
|
|
- **[Material API](swagger/SWAGGER_PHASE3_2_MATERIAL.md)** - 자재 관리 API
|
|
- **[Client API](swagger/SWAGGER_PHASE3_3_CLIENT.md)** - 거래처 관리 API
|
|
|
|
---
|
|
|
|
## 🧪 API Flow 테스트
|
|
|
|
API Flow Tester용 테스트 시나리오입니다.
|
|
|
|
### api-flows/
|
|
- **[item-fields-is-active-test.json](api-flows/item-fields-is-active-test.json)** - item_fields is_active 검증
|
|
- **[pricing-crud-flow.json](api-flows/pricing-crud-flow.json)** - 단가 CRUD 플로우
|
|
|
|
### flow-tests/
|
|
- **[attendance-api-crud.json](flow-tests/attendance-api-crud.json)** - 근태 API CRUD
|
|
- **[department-tree-api.json](flow-tests/department-tree-api.json)** - 부서 트리 API
|
|
- **[employee-api-crud.json](flow-tests/employee-api-crud.json)** - 직원 API CRUD
|
|
|
|
---
|
|
|
|
## 🔗 프로젝트 문서 (SAM/docs로 이동됨)
|
|
|
|
다음 문서들은 `/SAM/docs/`로 이동되었습니다:
|
|
|
|
| 이전 위치 | 새 위치 | 설명 |
|
|
|-----------|---------|------|
|
|
| `analysis/` | `docs/data/analysis/` | Item DB 분석 문서 |
|
|
| `front/` | `docs/front/` | 프론트엔드 요청 문서 |
|
|
| `specs/` | `docs/specs/` | 기능 스펙 문서 |
|
|
|
|
---
|
|
|
|
## 📝 문서 추가 가이드
|
|
|
|
| 문서 유형 | 저장 위치 |
|
|
|-----------|-----------|
|
|
| Swagger 스펙 | `api/docs/swagger/` |
|
|
| API Flow 테스트 | `api/docs/api-flows/` 또는 `flow-tests/` |
|
|
| 프로젝트 분석 | `SAM/docs/data/` |
|
|
| 기능 스펙 | `SAM/docs/specs/` |
|
|
| 프론트 요청 | `SAM/docs/front/` |
|