lifesub/design/마이구독/API설계서
2025-02-13 18:42:46 +09:00

18 lines
1.8 KiB
Plaintext

서비스명|마이구독|마이구독|마이구독|마이구독|마이구독|마이구독|마이구독
마이크로서비스 이름|MySubscription|MySubscription|MySubscription|MySubscription|MySubscription|MySubscription|MySubscription
유저스토리 ID|MSS-005|MSS-010|MSS-020|MSS-025|MSS-030|MSS-035|MSS-040
유저스토리 제목|총 구독료 표시|나의 구독 목록|구독상세|구독하기|구독취소|구독 카테고리 표시|구독서비스 목록
Controller 이름|MySubController|MySubController|ServiceController|ServiceController|ServiceController|CategoryController|CategoryController
API 목적|총 구독료 조회|구독 목록 조회|구독 상세 조회|구독 신청|구독 취소|전체 카테고리 목록 조회|카테고리별 서비스 목록 조회
API Method|GET|GET|GET|POST|DELETE|GET|GET
API 그룹 Path|/api/mysub|/api/mysub|/api/mysub/services|/api/mysub/services|/api/mysub/services|/api/mysub|/api/mysub
API Path|/total-fee|/list|/{subscriptionId}|/{subscriptionId}/subscribe|/{subscriptionId}|/categories|/services
Path <변수유형> <변수명>|||Long subscriptionId|Long subscriptionId|Long subscriptionId||
Query Key|userId|userId||userId|||categoryId
Query <변수유형> <변수명>|String userId|String userId||String userId|||String categoryId
Request DTO 이름|||||||
Request DTO 배열 여부|||||||
Request DTO 구조|||||||
Response DTO 이름|TotalFeeResponse|MySubResponse|SubDetailResponse||null|CategoryResponse|ServiceListResponse
Response DTO 배열 여부|No|Yes|No||No|Yes|Yes
Response DTO 구조|Long totalFee; String feeLevel|String serviceName; String logoUrl|String serviceName; String logoUrl; String category; String description; int price; int maxSharedUsers||null|String categoryId; String categoryName|String serviceId; String serviceName; String description; int price; String logoUrl