Files
sam-api/docs/INDEX.md

50 lines
1.5 KiB
Markdown
Raw Normal View History

# API 프로젝트 문서
> 📌 **SAM API 전용 문서 허브**
---
## 📋 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
---
## 🔍 분석 문서
Item 관리 시스템 분석 문서입니다.
- **[Item DB 분석 v3 (최신)](analysis/SAM_Item_DB_API_Analysis_v3_FINAL.md)** - Item DB 최종 분석
- **[Item DB 분석 v2](analysis/SAM_Item_DB_API_Analysis_v2.md)** - Item DB 분석 v2
- **[Item 관리 모델링](analysis/SAM_Item_Management_DB_Modeling_Analysis.md)** - Item DB 모델링 분석
---
## 🔗 관련 문서
- **[API Rules](../docs/reference/api-rules.md)** - API 개발 규칙
- **[Swagger Guide](../docs/guides/swagger-guide.md)** - Swagger 작성 가이드
- **[Database Schema](../docs/specs/database-schema.md)** - 전체 DB 스키마
---
## 🧪 API Flow 테스트
API Flow Tester용 테스트 시나리오입니다.
- **[ItemField is_active 테스트](api-flows/item-fields-is-active-test.json)** - item_fields is_active 컬럼 검증
---
## 📝 문서 추가
새로운 API 문서는 다음 디렉토리에 추가:
- Swagger 문서 → `swagger/`
- 분석 문서 → `analysis/`
- API Flow 테스트 → `api-flows/`