fix : exclude user principal in docs

JiwonKKang · JiwonKKang · commit 62cbaeb3e2d9 · 2024-12-01T18:54:32.000+09:00
diff --git a/game-service/game-application/app-api/src/main/kotlin/com/grepp/quizy/game/api/global/config/SwaggerConfig.kt b/game-service/game-application/app-api/src/main/kotlin/com/grepp/quizy/game/api/global/config/SwaggerConfig.kt
@@ -64,13 +64,9 @@ class SwaggerConfig {
 
 @Component
 class CustomOperationCustomizer : OperationCustomizer {
-
     override fun customize(operation: Operation, handlerMethod: HandlerMethod): Operation {
-        // @AuthUser 애노테이션이 적용된 파라미터 제거
         operation.parameters?.removeIf { parameter ->
-            handlerMethod.methodParameters.any { methodParam ->
-                methodParam.parameterAnnotations.any { it is AuthUser }
-            }
+            parameter.name == "userPrincipal" || parameter.name == "principal"
         }
         return operation
     }
diff --git a/matching-service/matching-application/app-api/src/main/kotlin/com/grepp/quizy/matching/api/config/SwaggerConfig.kt b/matching-service/matching-application/app-api/src/main/kotlin/com/grepp/quizy/matching/api/config/SwaggerConfig.kt
@@ -64,13 +64,9 @@ class SwaggerConfig {
 
 @Component
 class CustomOperationCustomizer : OperationCustomizer {
-
     override fun customize(operation: Operation, handlerMethod: HandlerMethod): Operation {
-        // @AuthUser 애노테이션이 적용된 파라미터 제거
         operation.parameters?.removeIf { parameter ->
-            handlerMethod.methodParameters.any { methodParam ->
-                methodParam.parameterAnnotations.any { it is AuthUser }
-            }
+            parameter.name == "userPrincipal" || parameter.name == "principal"
         }
         return operation
     }
diff --git a/quiz-service/quiz-application/app-api/build.gradle.kts b/quiz-service/quiz-application/app-api/build.gradle.kts
@@ -1,4 +1,13 @@
 import org.springframework.boot.gradle.tasks.bundling.BootJar
+import org.jetbrains.kotlin.gradle.dsl.KotlinCompile
+
+plugins {
+    kotlin("plugin.noarg") version "2.0.21"
+}
+
+noArg {
+    annotation("com.grepp.quizy.common.NoArg")
+}
 
 dependencies {
     implementation(project(":common:common-web"))
@@ -14,4 +23,10 @@ dependencies {
 
 tasks.named<BootJar>("bootJar") {
     enabled = true
+}
+
+tasks {
+    withType<JavaCompile> {
+        options.compilerArgs.add("-parameters")
+    }
 }
diff --git a/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/comment/CommentApi.kt b/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/comment/CommentApi.kt
@@ -6,6 +6,8 @@ import com.grepp.quizy.quiz.api.comment.dto.CreateCommentRequest
 import com.grepp.quizy.quiz.domain.comment.*
 import com.grepp.quizy.quiz.domain.quiz.QuizId
 import com.grepp.quizy.quiz.domain.user.UserId
+import com.grepp.quizy.web.annotation.AuthUser
+import com.grepp.quizy.web.dto.UserPrincipal
 import org.springframework.web.bind.annotation.*
 
 @RestController
@@ -58,8 +60,8 @@ class CommentApi(
 
     @DeleteMapping("/{id}")
     fun deleteComment(
-            @PathVariable id: Long,
-            userId: Long,
+        @PathVariable id: Long,
+        userId: Long,
     ): ApiResponse<Unit> =
             ApiResponse.success(
                     commentDeleteUseCase.deleteComment(
diff --git a/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/global/config/SwaggerConfig.kt b/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/global/config/SwaggerConfig.kt
@@ -1,6 +1,5 @@
 package com.grepp.quizy.quiz.api.global.config
 
-import com.grepp.quizy.web.annotation.AuthUser
 import io.swagger.v3.oas.annotations.OpenAPIDefinition
 import io.swagger.v3.oas.annotations.info.Info
 import io.swagger.v3.oas.models.Components
@@ -17,6 +16,7 @@ import org.springframework.context.annotation.Configuration
 import org.springframework.stereotype.Component
 import org.springframework.web.method.HandlerMethod
 
+
 @Configuration
 @OpenAPIDefinition(info = Info(title = "Quiz API", version = "v1"))
 class SwaggerConfig {
@@ -59,13 +59,9 @@ class SwaggerConfig {
 
 @Component
 class CustomOperationCustomizer : OperationCustomizer {
-
     override fun customize(operation: Operation, handlerMethod: HandlerMethod): Operation {
-        // @AuthUser 애노테이션이 적용된 파라미터 제거
         operation.parameters?.removeIf { parameter ->
-            handlerMethod.methodParameters.any { methodParam ->
-                methodParam.parameterAnnotations.any { it is AuthUser }
-            }
+            parameter.name == "userPrincipal" || parameter.name == "principal"
         }
         return operation
     }
diff --git a/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/like/LikeApi.kt b/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/like/LikeApi.kt
@@ -1,17 +1,15 @@
 package com.grepp.quizy.quiz.api.like
 
 import com.grepp.quizy.common.api.ApiResponse
+import com.grepp.quizy.quiz.api.like.dto.LikeRequest
 import com.grepp.quizy.quiz.domain.like.Like
 import com.grepp.quizy.quiz.domain.like.LikeService
 import com.grepp.quizy.quiz.domain.quiz.QuizId
 import com.grepp.quizy.quiz.domain.user.UserId
 import com.grepp.quizy.web.annotation.AuthUser
 import com.grepp.quizy.web.dto.UserPrincipal
 import io.swagger.v3.oas.annotations.Parameter
-import org.springframework.web.bind.annotation.PostMapping
-import org.springframework.web.bind.annotation.RequestMapping
-import org.springframework.web.bind.annotation.RequestParam
-import org.springframework.web.bind.annotation.RestController
+import org.springframework.web.bind.annotation.*
 
 @RestController
 @RequestMapping("/api/quiz/likes")
@@ -20,9 +18,9 @@ class LikeApi(private val likeService: LikeService) {
     @PostMapping
     fun toggleLike(
         @AuthUser principal: UserPrincipal,
-        @RequestParam quizId: Long,
+        @RequestBody request: LikeRequest,
     ): ApiResponse<Boolean> =
             ApiResponse.success(
-                    likeService.toggleLike(Like(quizId = QuizId(quizId), likerId = UserId(principal.value)))
+                    likeService.toggleLike(request.toLike(principal.value))
             )
 }
diff --git a/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/like/dto/LikeRequest.kt b/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/like/dto/LikeRequest.kt
@@ -1,11 +1,13 @@
 package com.grepp.quizy.quiz.api.like.dto
 
+import com.grepp.quizy.common.NoArg
 import com.grepp.quizy.quiz.domain.like.Like
 import com.grepp.quizy.quiz.domain.quiz.QuizId
 import com.grepp.quizy.quiz.domain.user.UserId
 
-data class LikeRequest(val quizId: Long, val userId: Long) {
+@NoArg
+data class LikeRequest(val quizId: Long) {
 
-    fun toLike(): Like =
+    fun toLike(userId: Long): Like =
             Like(quizId = QuizId(quizId), likerId = UserId(userId))
 }
diff --git a/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/quiz/QuizApi.kt b/quiz-service/quiz-application/app-api/src/main/kotlin/com/grepp/quizy/quiz/api/quiz/QuizApi.kt
@@ -9,7 +9,6 @@ import com.grepp.quizy.quiz.domain.quiz.*
 import com.grepp.quizy.quiz.domain.user.UserId
 import com.grepp.quizy.web.annotation.AuthUser
 import com.grepp.quizy.web.dto.UserPrincipal
-import io.swagger.v3.oas.annotations.Parameter
 import org.springframework.web.bind.annotation.DeleteMapping
 import org.springframework.web.bind.annotation.GetMapping
 import org.springframework.web.bind.annotation.PathVariable
@@ -58,8 +57,8 @@ class QuizApi(
     @PutMapping("/{id}")
     fun updateQuiz(
             @PathVariable id: Long,
-            @AuthUser userPrincipal: UserPrincipal,
             @RequestBody request: UpdateQuizRequest,
+            @AuthUser userPrincipal: UserPrincipal,
     ): ApiResponse<QuizResponse> =
             ApiResponse.success(
                     QuizResponse.from(
diff --git a/quiz-service/quiz-infra/src/main/kotlin/com/grepp/quizy/quiz/infra/image/entity/QuizImageEntity.kt b/quiz-service/quiz-infra/src/main/kotlin/com/grepp/quizy/quiz/infra/image/entity/QuizImageEntity.kt
@@ -5,7 +5,7 @@ import com.grepp.quizy.quiz.domain.image.QuizImageId
 import jakarta.persistence.*
 
 @Entity
-@Table(name = "quiz_image")
+@Table(name = "quiz_images")
 class QuizImageEntity(
     @Id @GeneratedValue(strategy = GenerationType.IDENTITY)
     val id: Long,
diff --git a/quiz-service/quiz-infra/src/main/kotlin/com/grepp/quizy/quiz/infra/image/repository/QuizImageJpaRepository.kt b/quiz-service/quiz-infra/src/main/kotlin/com/grepp/quizy/quiz/infra/image/repository/QuizImageJpaRepository.kt
@@ -2,10 +2,12 @@ package com.grepp.quizy.quiz.infra.image.repository
 
 import com.grepp.quizy.quiz.infra.image.entity.QuizImageEntity
 import org.springframework.data.jpa.repository.JpaRepository
+import org.springframework.data.jpa.repository.Modifying
 import org.springframework.data.jpa.repository.Query
 
 interface QuizImageJpaRepository : JpaRepository<QuizImageEntity, Long> {
 
+    @Modifying
     @Query("DELETE FROM QuizImageEntity q WHERE q.id IN :ids")
     fun deleteByIdIn(ids: List<Long>)
 }
diff --git a/user-service/user-application/app-api/src/main/kotlin/com/grepp/quizy/user/api/global/config/SwaggerConfig.kt b/user-service/user-application/app-api/src/main/kotlin/com/grepp/quizy/user/api/global/config/SwaggerConfig.kt
@@ -64,13 +64,9 @@ class SwaggerConfig {
 
 @Component
 class CustomOperationCustomizer : OperationCustomizer {
-
     override fun customize(operation: Operation, handlerMethod: HandlerMethod): Operation {
-        // @AuthUser 애노테이션이 적용된 파라미터 제거
         operation.parameters?.removeIf { parameter ->
-            handlerMethod.methodParameters.any { methodParam ->
-                methodParam.parameterAnnotations.any { it is AuthUser }
-            }
+            parameter.name == "userPrincipal" || parameter.name == "principal"
         }
         return operation
     }

Original file line number	Diff line number	Diff line change
`@@ -64,13 +64,9 @@ class SwaggerConfig {`
`64`	`64`
`65`	`65`	`@Component`
`66`	`66`	`class CustomOperationCustomizer : OperationCustomizer {`
`67`		`-`
`68`	`67`	`override fun customize(operation: Operation, handlerMethod: HandlerMethod): Operation {`
`69`		`- // @AuthUser 애노테이션이 적용된 파라미터 제거`
`70`	`68`	`operation.parameters?.removeIf { parameter ->`
`71`		`- handlerMethod.methodParameters.any { methodParam ->`
`72`		`- methodParam.parameterAnnotations.any { it is AuthUser }`
`73`		`- }`
	`69`	`+ parameter.name == "userPrincipal" \|\| parameter.name == "principal"`
`74`	`70`	`}`
`75`	`71`	`return operation`
`76`	`72`	`}`