🚀 :: Api-v0.0.4

🚀 :: Api-v0.0.4

DuDoong-Api/src/main/java/band/gosrock/api/auth/controller/AuthController.java

@@ -14,7 +14,9 @@
 import band.gosrock.api.auth.service.RegisterUseCase;
 import band.gosrock.api.auth.service.WithDrawUseCase;
 import band.gosrock.api.auth.service.helper.CookieGenerateHelper;
+import band.gosrock.common.annotation.ApiErrorCodeExample;
 import band.gosrock.common.annotation.DevelopOnlyApi;
+import band.gosrock.infrastructure.outer.api.oauth.exception.KakaoKauthErrorCode;
 import io.swagger.v3.oas.annotations.Operation;
 import io.swagger.v3.oas.annotations.security.SecurityRequirement;
 import io.swagger.v3.oas.annotations.tags.Tag;
@@ -81,9 +83,10 @@ public OauthLoginLinkResponse getKakaoOauthLink(
         return registerUseCase.getKaKaoOauthLink(referer);
     }
 
-    @Operation(summary = "code 요청받는 핸들러 클라이언트가 몰라도됩니다.")
+    @Operation(summary = "카카오 code 요청받는 곳입니다. referer,host는 건들이지 말아주세요!안보내셔도됩니다.")
     @Tag(name = "카카오 oauth")
     @GetMapping("/oauth/kakao")
+    @ApiErrorCodeExample(KakaoKauthErrorCode.class)
     public OauthTokenResponse getCredentialFromKaKao(
             @RequestParam("code") String code,
             @RequestHeader(value = "referer", required = false) String referer,

DuDoong-Api/src/main/java/band/gosrock/api/cart/model/dto/response/CartItemResponse.java

@@ -4,6 +4,7 @@
 import band.gosrock.domain.common.vo.Money;
 import band.gosrock.domain.common.vo.OptionAnswerVo;
 import band.gosrock.domain.domains.cart.domain.CartLineItem;
+import io.swagger.v3.oas.annotations.media.Schema;
 import java.util.List;
 import lombok.Builder;
 import lombok.Getter;
@@ -13,19 +14,29 @@
 public class CartItemResponse {
 
     // 일반티켓(1/3) - 4000원
+    @Schema(description = "카트라인의 이름입니다.", defaultValue = "일반티켓(1/3) - 4000원")
     private String name;
     // 응답 목록
     private List<OptionAnswerVo> answers;
 
+    @Schema(description = "아이템 공급가액입니다.", defaultValue = "3000원")
     private Money itemPrice;
+
+    @Schema(
+            description = "카트 라인의 총 가격입니다. 옵션등을 통해서 공급가액에 합산되는 형식입니다. (아이템가격 + 옵션가) * 아이템 개수",
+            defaultValue = "4000원")
     private Money cartLinePrice;
 
+    @Schema(description = "담은 상품의 개수입니다.", defaultValue = "1")
+    private Long packedQuantity;
+
     public static CartItemResponse of(String name, CartLineItem cartLineItem) {
         return CartItemResponse.builder()
                 .answers(cartLineItem.getOptionAnswerVos())
                 .name(name)
                 .cartLinePrice(cartLineItem.getTotalCartLinePrice())
                 .itemPrice(cartLineItem.getItemPrice())
+                .packedQuantity(cartLineItem.getQuantity())
                 .build();
     }
 }

DuDoong-Api/src/main/java/band/gosrock/api/cart/model/dto/response/CreateCartResponse.java

@@ -3,31 +3,39 @@
 
 import band.gosrock.domain.common.vo.Money;
 import band.gosrock.domain.domains.cart.domain.Cart;
+import io.swagger.v3.oas.annotations.media.Schema;
 import java.util.List;
 import lombok.Builder;
 import lombok.Getter;
 
 @Getter
 @Builder
 public class CreateCartResponse {
-
+    @Schema(description = "장바구니명 입니다.", defaultValue = "")
     private final String title;
     // 내티켓 확인하기
     private final List<CartItemResponse> items;
 
     // 금액
+    @Schema(description = "카트라인들의 총 결제금액을 합한 금액입니다", defaultValue = "15000원")
     private final Money totalPrice;
 
+    @Schema(description = "생성한 장바구니의 아이디입니다", defaultValue = "30")
     private final Long cartId;
 
+    @Schema(description = "전체 아이템 수량을 의미합니다", defaultValue = "3")
     private final Long totalQuantity;
 
+    @Schema(description = "결제가 필요한지에 대한 여부를 결정합니다. 필요한 true면 결제창 띄우시면됩니다.", defaultValue = "true")
+    private final Boolean isNeedPayment;
+
     public static CreateCartResponse of(List<CartItemResponse> cartItemResponses, Cart cart) {
         return CreateCartResponse.builder()
                 .items(cartItemResponses)
                 .totalPrice(cart.getTotalPrice())
                 .cartId(cart.getId())
                 .title(cart.getCartName())
+                .isNeedPayment(cart.isNeedPayment())
                 .totalQuantity(cart.getTotalQuantity())
                 .build();
     }

DuDoong-Api/src/main/java/band/gosrock/api/config/ExampleHolder.java

@@ -2,11 +2,11 @@
 
 
 import io.swagger.v3.oas.models.examples.Example;
-import lombok.AllArgsConstructor;
+import lombok.Builder;
 import lombok.Getter;
 
 @Getter
-@AllArgsConstructor
+@Builder
 public class ExampleHolder {
     private Example holder;
     private String name;

DuDoong-Api/src/main/java/band/gosrock/api/config/SwaggerConfig.java

@@ -2,11 +2,13 @@
 
 import static java.util.stream.Collectors.groupingBy;
 
-import band.gosrock.common.annotation.ApiErrorExample;
+import band.gosrock.common.annotation.ApiErrorCodeExample;
+import band.gosrock.common.annotation.ApiErrorExceptionsExample;
 import band.gosrock.common.annotation.DisableSwaggerSecurity;
 import band.gosrock.common.annotation.ExplainError;
 import band.gosrock.common.dto.ErrorReason;
 import band.gosrock.common.dto.ErrorResponse;
+import band.gosrock.common.exception.BaseErrorCode;
 import band.gosrock.common.exception.DuDoongCodeException;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import io.swagger.v3.core.jackson.ModelResolver;
@@ -86,8 +88,11 @@ public OperationCustomizer customize() {
         return (Operation operation, HandlerMethod handlerMethod) -> {
             DisableSwaggerSecurity methodAnnotation =
                     handlerMethod.getMethodAnnotation(DisableSwaggerSecurity.class);
-            ApiErrorExample apiErrorExample =
-                    handlerMethod.getMethodAnnotation(ApiErrorExample.class);
+            ApiErrorExceptionsExample apiErrorExceptionsExample =
+                    handlerMethod.getMethodAnnotation(ApiErrorExceptionsExample.class);
+            ApiErrorCodeExample apiErrorCodeExample =
+                    handlerMethod.getMethodAnnotation(ApiErrorCodeExample.class);
+
             List<String> tags = getTags(handlerMethod);
             // DisableSecurity 어노테이션있을시 스웨거 시큐리티 설정 삭제
             if (methodAnnotation != null) {
@@ -97,22 +102,62 @@ public OperationCustomizer customize() {
             if (!tags.isEmpty()) {
                 operation.setTags(Collections.singletonList(tags.get(0)));
             }
-            // ApiErrorExample 어노테이션 단 클래스에 적용
-            if (apiErrorExample != null) {
-                generateErrorResponseExample(operation, apiErrorExample.value());
+            // ApiErrorExceptionsExample 어노테이션 단 메소드 적용
+            if (apiErrorExceptionsExample != null) {
+                generateExceptionResponseExample(operation, apiErrorExceptionsExample.value());
+            }
+            // ApiErrorCodeExample 어노테이션 단 메소드 적용
+            if (apiErrorCodeExample != null) {
+                generateErrorCodeResponseExample(operation, apiErrorCodeExample.value());
             }
             return operation;
         };
     }
+    /**
+     * BaseErrorCode 타입의 이넘값들을 문서화 시킵니다. ExplainError 어노테이션으로 부가설명을 붙일수있습니다. 필드들을 가져와서 예시 에러 객체를
+     * 동적으로 생성해서 예시값으로 붙입니다.
+     */
+    private void generateErrorCodeResponseExample(
+            Operation operation, Class<? extends BaseErrorCode> type) {
+        ApiResponses responses = operation.getResponses();
 
-    /** ExplainError 어노테이션으로 부가설명을 붙일수있습니다. 필드들을 가져와서 예시 에러 객체를 동적으로 생성해서 예시값으로 붙입니다. */
-    private void generateErrorResponseExample(Operation operation, Class<?> type) {
+        BaseErrorCode[] errorCodes = type.getEnumConstants();
+
+        Map<Integer, List<ExampleHolder>> statusWithExampleHolders =
+                Arrays.stream(errorCodes)
+                        .map(
+                                baseErrorCode -> {
+                                    try {
+                                        ErrorReason errorReason = baseErrorCode.getErrorReason();
+                                        return ExampleHolder.builder()
+                                                .holder(
+                                                        getSwaggerExample(
+                                                                baseErrorCode.getExplainError(),
+                                                                errorReason))
+                                                .code(errorReason.getStatus())
+                                                .name(errorReason.getCode())
+                                                .build();
+                                    } catch (NoSuchFieldException e) {
+                                        throw new RuntimeException(e);
+                                    }
+                                })
+                        .collect(groupingBy(ExampleHolder::getCode));
+
+        addExamplesToResponses(responses, statusWithExampleHolders);
+    }
+
+    /**
+     * SwaggerExampleExceptions 타입의 클래스를 문서화 시킵니다. SwaggerExampleExceptions 타입의 클래스는 필드로
+     * DuDoongCodeException 타입을 가지며, DuDoongCodeException 의 errorReason 와,ExplainError 의 설명을
+     * 문서화시킵니다.
+     */
+    private void generateExceptionResponseExample(Operation operation, Class<?> type) {
         ApiResponses responses = operation.getResponses();
 
         // ----------------생성
         Object bean = applicationContext.getBean(type);
         Field[] declaredFields = bean.getClass().getDeclaredFields();
-        Map<Integer, List<ExampleHolder>> stringListMap =
+        Map<Integer, List<ExampleHolder>> statusWithExampleHolders =
                 Arrays.stream(declaredFields)
                         .filter(field -> field.getAnnotation(ExplainError.class) != null)
                         .filter(field -> field.getType() == DuDoongCodeException.class)
@@ -124,23 +169,33 @@ private void generateErrorResponseExample(Operation operation, Class<?> type) {
                                         ExplainError annotation =
                                                 field.getAnnotation(ExplainError.class);
                                         String value = annotation.value();
-                                        ErrorReason errorReason =
-                                                exception.getErrorCode().getErrorReason();
-                                        ErrorResponse errorResponse =
-                                                new ErrorResponse(errorReason, "요청시 패스정보입니다.");
-                                        Example example = new Example();
-                                        example.description(value);
-                                        example.setValue(errorResponse);
-                                        return new ExampleHolder(
-                                                example, field.getName(), errorReason.getStatus());
+                                        ErrorReason errorReason = exception.getErrorReason();
+                                        return ExampleHolder.builder()
+                                                .holder(getSwaggerExample(value, errorReason))
+                                                .code(errorReason.getStatus())
+                                                .name(field.getName())
+                                                .build();
                                     } catch (IllegalAccessException e) {
                                         throw new RuntimeException(e);
                                     }
                                 })
                         .collect(groupingBy(ExampleHolder::getCode));
 
         // -------------------------- 콘텐츠 세팅 코드별로 진행
-        stringListMap.forEach(
+        addExamplesToResponses(responses, statusWithExampleHolders);
+    }
+
+    private Example getSwaggerExample(String value, ErrorReason errorReason) {
+        ErrorResponse errorResponse = new ErrorResponse(errorReason, "요청시 패스정보입니다.");
+        Example example = new Example();
+        example.description(value);
+        example.setValue(errorResponse);
+        return example;
+    }
+
+    private void addExamplesToResponses(
+            ApiResponses responses, Map<Integer, List<ExampleHolder>> statusWithExampleHolders) {
+        statusWithExampleHolders.forEach(
                 (status, v) -> {
                     Content content = new Content();
                     MediaType mediaType = new MediaType();

DuDoong-Api/src/main/java/band/gosrock/api/config/response/GlobalExceptionHandler.java

@@ -1,10 +1,12 @@
 package band.gosrock.api.config.response;
 
 
+import band.gosrock.common.dto.ErrorReason;
 import band.gosrock.common.dto.ErrorResponse;
+import band.gosrock.common.exception.BaseErrorCode;
 import band.gosrock.common.exception.DuDoongCodeException;
 import band.gosrock.common.exception.DuDoongDynamicException;
-import band.gosrock.common.exception.ErrorCode;
+import band.gosrock.common.exception.GlobalErrorCode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import java.util.List;
@@ -79,10 +81,12 @@ protected ResponseEntity<Object> handleMethodArgumentNotValid(
     @ExceptionHandler(DuDoongCodeException.class)
     public ResponseEntity<ErrorResponse> DuDoongCodeExceptionHandler(
             DuDoongCodeException e, HttpServletRequest request) {
-        ErrorCode code = e.getErrorCode();
+        BaseErrorCode code = e.getErrorCode();
+        ErrorReason errorReason = code.getErrorReason();
         ErrorResponse errorResponse =
-                new ErrorResponse(code.getErrorReason(), request.getRequestURL().toString());
-        return ResponseEntity.status(HttpStatus.valueOf(code.getStatus())).body(errorResponse);
+                new ErrorResponse(errorReason, request.getRequestURL().toString());
+        return ResponseEntity.status(HttpStatus.valueOf(errorReason.getStatus()))
+                .body(errorResponse);
     }
 
     @ExceptionHandler(DuDoongDynamicException.class)
@@ -107,7 +111,7 @@ protected ResponseEntity<ErrorResponse> handleException(Exception e, HttpServlet
                         .toUriString();
 
         log.error("INTERNAL_SERVER_ERROR", e);
-        ErrorCode internalServerError = ErrorCode.INTERNAL_SERVER_ERROR;
+        GlobalErrorCode internalServerError = GlobalErrorCode.INTERNAL_SERVER_ERROR;
         ErrorResponse errorResponse =
                 new ErrorResponse(
                         internalServerError.getStatus(),

DuDoong-Api/src/main/java/band/gosrock/api/config/security/AccessDeniedFilter.java

@@ -1,9 +1,10 @@
 package band.gosrock.api.config.security;
 
 
+import band.gosrock.common.dto.ErrorReason;
 import band.gosrock.common.dto.ErrorResponse;
+import band.gosrock.common.exception.BaseErrorCode;
 import band.gosrock.common.exception.DuDoongCodeException;
-import band.gosrock.common.exception.ErrorCode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import javax.servlet.FilterChain;
@@ -46,9 +47,10 @@ protected void doFilterInternal(
         }
     }
 
-    private ErrorResponse getErrorResponse(ErrorCode errorCode, String path) {
+    private ErrorResponse getErrorResponse(BaseErrorCode errorCode, String path) {
+        ErrorReason errorReason = errorCode.getErrorReason();
         return new ErrorResponse(
-                errorCode.getStatus(), errorCode.getCode(), errorCode.getReason(), path);
+                errorReason.getStatus(), errorReason.getCode(), errorReason.getReason(), path);
     }
 
     private void responseToClient(HttpServletResponse response, ErrorResponse errorResponse)

DuDoong-Api/src/main/java/band/gosrock/api/config/security/JwtExceptionFilter.java

@@ -2,8 +2,8 @@
 
 
 import band.gosrock.common.dto.ErrorResponse;
+import band.gosrock.common.exception.BaseErrorCode;
 import band.gosrock.common.exception.DuDoongCodeException;
-import band.gosrock.common.exception.ErrorCode;
 import com.fasterxml.jackson.databind.ObjectMapper;
 import java.io.IOException;
 import javax.servlet.FilterChain;
@@ -36,7 +36,7 @@ protected void doFilterInternal(
         }
     }
 
-    private ErrorResponse getErrorResponse(ErrorCode errorCode, String path) {
+    private ErrorResponse getErrorResponse(BaseErrorCode errorCode, String path) {
 
         return new ErrorResponse(errorCode.getErrorReason(), path);
     }

DuDoong-Api/src/main/java/band/gosrock/api/eventHandlers/OrderEventHandler.java

@@ -0,0 +1,33 @@
+package band.gosrock.api.eventHandlers;
+
+
+import band.gosrock.domain.common.events.order.DoneOrderEvent;
+import band.gosrock.domain.common.events.order.WithDrawOrderEvent;
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.scheduling.annotation.Async;
+import org.springframework.stereotype.Component;
+import org.springframework.transaction.event.TransactionPhase;
+import org.springframework.transaction.event.TransactionalEventListener;
+
+@Component
+@RequiredArgsConstructor
+@Slf4j
+public class OrderEventHandler {
+
+    @Async
+    @TransactionalEventListener(
+            classes = DoneOrderEvent.class,
+            phase = TransactionPhase.AFTER_COMMIT)
+    public void handleDoneOrderEvent(DoneOrderEvent doneOrderEvent) {
+        log.info(doneOrderEvent.getUuid() + "주문 상태 완료, 티켓 생성필요");
+    }
+
+    @Async
+    @TransactionalEventListener(
+            classes = WithDrawOrderEvent.class,
+            phase = TransactionPhase.AFTER_COMMIT)
+    public void handleRegisterUserEvent(WithDrawOrderEvent withDrawOrderEvent) {
+        log.info(withDrawOrderEvent.getUuid() + "주문 상태 철회 , 티켓 제거 필요");
+    }
+}