config: swagger scan 패키지를 수정한다. (#79)

* feat: swagger scan 패키지를 수정한다. * feat: 누락된 Tag, Operation을 추가한다.
YAPP-Github · May 1, 2024 · 4f9bc09 · 4f9bc09
1 parent 5232cd4
commit 4f9bc09
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 3 deletions.
diff --git a/src/main/java/com/moneymong/domain/invitationcode/api/InviteCodeController.java b/src/main/java/com/moneymong/domain/invitationcode/api/InviteCodeController.java
@@ -6,11 +6,13 @@
 import com.moneymong.domain.invitationcode.service.InvitationCodeService;
 import com.moneymong.global.security.token.dto.jwt.JwtAuthentication;
 import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import jakarta.validation.Valid;
 import lombok.RequiredArgsConstructor;
 import org.springframework.security.core.annotation.AuthenticationPrincipal;
 import org.springframework.web.bind.annotation.*;
 
+@Tag(name = "4. [초대코드]")
 @RequestMapping("/api/v1/agencies/{agencyId}/invitation-code")
 @RequiredArgsConstructor
 @RestController

diff --git a/src/main/java/com/moneymong/global/config/docs/OpenApiConfig.java b/src/main/java/com/moneymong/global/config/docs/OpenApiConfig.java
@@ -11,7 +11,7 @@
 import org.springframework.context.annotation.Profile;
 
 @Configuration
-@Profile({"local", "dev", "prod"})
+@Profile({"dev", "prod"})
 public class OpenApiConfig {
 
     @Bean

diff --git a/src/main/java/com/moneymong/global/image/api/ImageController.java b/src/main/java/com/moneymong/global/image/api/ImageController.java
@@ -3,6 +3,8 @@
 import com.moneymong.global.image.dto.ImageDeleteRequest;
 import com.moneymong.global.image.dto.ImageResponse;
 import com.moneymong.global.image.service.ImageService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.DeleteMapping;
 import org.springframework.web.bind.annotation.ModelAttribute;
@@ -16,19 +18,22 @@
 import static org.springframework.http.MediaType.*;
 import static org.springframework.http.MediaType.MULTIPART_FORM_DATA_VALUE;
 
+@Tag(name = "9. [이미지]")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1/images")
 public class ImageController {
 
     private final ImageService imageService;
 
+    @Operation(summary = "이미지 업로드")
     @PostMapping(consumes = {MULTIPART_FORM_DATA_VALUE, APPLICATION_JSON_VALUE})
     public ImageResponse upload(@RequestPart("file") MultipartFile multipartFile) {
         ImageResponse response = imageService.upload(multipartFile);
         return response;
     }
 
+    @Operation(summary = "이미지 삭제 API")
     @DeleteMapping(consumes = APPLICATION_JSON_VALUE)
     public void remove(@RequestBody ImageDeleteRequest deleteRequest) {
         imageService.remove(deleteRequest);

diff --git a/src/main/java/com/moneymong/global/security/token/api/TokenController.java b/src/main/java/com/moneymong/global/security/token/api/TokenController.java
@@ -4,23 +4,27 @@
 import com.moneymong.global.security.token.api.request.RefreshAccessTokenRequest;
 import com.moneymong.global.security.token.api.response.TokenResponse;
 import com.moneymong.global.security.token.service.TokenService;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.web.bind.annotation.*;
 
-
+@Tag(name = "0. [로그인]")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/v1/tokens")
 public class TokenController {
 
 	private final TokenService tokenService;
 
+	@Operation(summary = "AccessToken 갱신")
 	@PostMapping
 	public TokenResponse refreshAccessToken(@RequestBody RefreshAccessTokenRequest refreshAccessTokenRequest) {
 		String refreshToken = refreshAccessTokenRequest.getRefreshToken();
 		return tokenService.getAccessTokensByRefreshToken(refreshToken);
 	}
 
+	@Operation(summary = "로그아웃")
 	@DeleteMapping
 	public void deleteRefreshToken(@RequestBody DeleteRefreshTokenRequest deleteRefreshTokenRequest) {
 		String refreshToken = deleteRefreshTokenRequest.getRefreshToken();

diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml
@@ -32,7 +32,7 @@ management:
 
 # swagger
 springdoc:
-  packages-to-scan: com.moneymong.domain
+  packages-to-scan: com.moneymong
   default-consumes-media-type: application/json;charset=UTF-8
   default-produces-media-type: application/json;charset=UTF-8
   swagger-ui: