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
@@ -24,18 +24,16 @@ info:
version: 1.0.0
contact:
name: Backend Development Team
email: backend@kt-event-marketing.com
name: Digital Garage Team
email: support@kt-event-marketing.com
servers:
- url: http://localhost:8083
- url: http://localhost:8085
description: Local Development Server
- url: http://distribution-service:8083
description: Docker/Kubernetes Service
- url: https://api-dev.kt-event-marketing.com/distribution
description: Development Environment
- url: https://api.kt-event-marketing.com/distribution
description: Production Environment
- url: https://dev-api.kt-event-marketing.com/distribution/v1
description: Development Server
- url: https://api.kt-event-marketing.com/distribution/v1
description: Production Server
tags:
- name: Distribution
@@ -44,7 +42,7 @@ tags:
description: 배포 상태 모니터링
paths:
/api/distribution/distribute:
/distribution/distribute:
post:
tags:
- Distribution
@@ -174,7 +172,7 @@ paths:
message: "배포 처리 중 오류가 발생했습니다"
timestamp: "2025-11-01T09:00:00Z"
/api/distribution/{eventId}/status:
/distribution/{eventId}/status:
get:
tags:
- Monitoring