7개 마이크로서비스 API 명세서 컨벤션 통일

- 공통 OpenAPI 3.0.3 컨벤션 문서 작성 (design/backend/api/API_CONVENTION.md)
- 7개 서비스 API 명세서 표준화 완료:
  * User Service (8081)
  * Event Service (8080)
  * Content Service (8082)
  * AI Service (8083)
  * Participation Service (8084)
  * Distribution Service (8085)
  * Analytics Service (8086)

주요 변경사항:
- API 경로에서 /api prefix 제거 (/api/users → /users)
- 서버 URL 패턴 통일 (Local → Dev → Prod)
- 연락처 정보 표준화 (Digital Garage Team)
- ErrorResponse 스키마 통일 (error → message, details 추가)
- securitySchemes 이름 통일 (BearerAuth)
- 포트 번호 명확히 할당

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
This commit is contained in:
cherry2250
2025-10-23 17:12:28 +09:00
parent b9745f24e5
commit 6b1c4224f7
8 changed files with 1080 additions and 151 deletions
@@ -27,15 +27,15 @@ info:
- Real-time updates via Kafka event subscription
version: 1.0.0
contact:
name: Analytics Service Team
email: analytics@kt-event.com
name: Digital Garage Team
email: support@kt-event-marketing.com
servers:
- url: http://localhost:8086
description: Local Development Server
- url: https://api-dev.kt-event.com/analytics
- url: https://dev-api.kt-event-marketing.com/analytics/v1
description: Development Server
- url: https://api.kt-event.com/analytics
- url: https://api.kt-event-marketing.com/analytics/v1
description: Production Server
tags:
@@ -49,7 +49,7 @@ tags:
description: 투자 대비 수익률 분석 API
paths:
/api/events/{eventId}/analytics:
/events/{eventId}/analytics:
get:
tags:
- Analytics
@@ -115,7 +115,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/events/{eventId}/analytics/channels:
/events/{eventId}/analytics/channels:
get:
tags:
- Channels
@@ -188,7 +188,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/events/{eventId}/analytics/timeline:
/events/{eventId}/analytics/timeline:
get:
tags:
- Timeline
@@ -264,7 +264,7 @@ paths:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/events/{eventId}/analytics/roi:
/events/{eventId}/analytics/roi:
get:
tags:
- ROI