refactor: tab and swagger tag

PrayHelper · Nov 14, 2023 · 7fd4b1a · 7fd4b1a
1 parent a5be72d
commit 7fd4b1a
Show file tree

Hide file tree

Showing 5 changed files with 171 additions and 171 deletions.
diff --git a/src/main/java/com/uspray/uspray/controller/AuthController.java b/src/main/java/com/uspray/uspray/controller/AuthController.java
@@ -34,80 +34,80 @@
 @RestController
 @RequestMapping("/auth")
 @RequiredArgsConstructor
-@Tag(name = "회원 관리", description = "Auth 관련 API")
+@Tag(name = "Auth", description = "Auth 관련 API")
 public class AuthController {
 
-  private final TokenProvider tokenProvider;
-  private final AuthService authService;
+    private final TokenProvider tokenProvider;
+    private final AuthService authService;
 
-  @PostMapping("/signup")
-  @ApiResponse(
-      responseCode = "201",
-      description = "회원가입 성공",
-      content = @Content(schema = @Schema(implementation = MemberResponseDto.class)))
-  public ApiResponseDto<MemberResponseDto> signup(
-      @RequestBody @Valid MemberRequestDto memberRequestDto) {
-    return ApiResponseDto.success(SuccessStatus.SIGNUP_SUCCESS,
-        authService.signup(memberRequestDto));
-  }
+    @PostMapping("/signup")
+    @ApiResponse(
+        responseCode = "201",
+        description = "회원가입 성공",
+        content = @Content(schema = @Schema(implementation = MemberResponseDto.class)))
+    public ApiResponseDto<MemberResponseDto> signup(
+        @RequestBody @Valid MemberRequestDto memberRequestDto) {
+        return ApiResponseDto.success(SuccessStatus.SIGNUP_SUCCESS,
+            authService.signup(memberRequestDto));
+    }
 
-  @PostMapping("/login")
-  @ApiResponse(
-      responseCode = "200",
-      description = "로그인 성공",
-      content = @Content(schema = @Schema(implementation = MemberResponseDto.class)))
-  public ApiResponseDto<TokenDto> login(
-      @RequestBody MemberLoginRequestDto memberLoginRequestDto) {
-    return ApiResponseDto.success(SuccessStatus.LOGIN_SUCCESS,
-        authService.login(memberLoginRequestDto));
-  }
+    @PostMapping("/login")
+    @ApiResponse(
+        responseCode = "200",
+        description = "로그인 성공",
+        content = @Content(schema = @Schema(implementation = MemberResponseDto.class)))
+    public ApiResponseDto<TokenDto> login(
+        @RequestBody MemberLoginRequestDto memberLoginRequestDto) {
+        return ApiResponseDto.success(SuccessStatus.LOGIN_SUCCESS,
+            authService.login(memberLoginRequestDto));
+    }
 
-  @PostMapping("/reissue")
-  @ApiResponse(
-      responseCode = "200",
-      description = "토큰 재발급 성공",
-      content = @Content(schema = @Schema(implementation = TokenDto.class)))
-  @SecurityRequirements({
-      @SecurityRequirement(name = "JWT Auth"),
-      @SecurityRequirement(name = "Refresh")
-  })
-  public ApiResponseDto<TokenDto> reissue(@Parameter(hidden = true) HttpServletRequest request) {
-    String accessToken = request.getHeader("Authorization").substring(7);
-    String refreshToken = request.getHeader("Refresh");
-    return ApiResponseDto.success(SuccessStatus.REISSUE_SUCCESS,
-        authService.reissue(accessToken, refreshToken));
-  }
+    @PostMapping("/reissue")
+    @ApiResponse(
+        responseCode = "200",
+        description = "토큰 재발급 성공",
+        content = @Content(schema = @Schema(implementation = TokenDto.class)))
+    @SecurityRequirements({
+        @SecurityRequirement(name = "JWT Auth"),
+        @SecurityRequirement(name = "Refresh")
+    })
+    public ApiResponseDto<TokenDto> reissue(@Parameter(hidden = true) HttpServletRequest request) {
+        String accessToken = request.getHeader("Authorization").substring(7);
+        String refreshToken = request.getHeader("Refresh");
+        return ApiResponseDto.success(SuccessStatus.REISSUE_SUCCESS,
+            authService.reissue(accessToken, refreshToken));
+    }
 
 
-  @PostMapping("/find-id")
-  @Operation(summary = "아이디 찾기")
-  public ApiResponseDto<String> findId(@RequestBody FindIdDto findIdDto) {
-    return ApiResponseDto.success(SuccessStatus.FIND_USER_ID_SUCCESS,
-        authService.findId(findIdDto));
-  }
+    @PostMapping("/find-id")
+    @Operation(summary = "아이디 찾기")
+    public ApiResponseDto<String> findId(@RequestBody FindIdDto findIdDto) {
+        return ApiResponseDto.success(SuccessStatus.FIND_USER_ID_SUCCESS,
+            authService.findId(findIdDto));
+    }
 
-  @PostMapping("/find-pw")
-  @Operation(summary = "비밀번호 찾기")
-  public ApiResponseDto<?> findId(@RequestBody FindPwDto findPwDto) {
-    authService.findPw(findPwDto);
-    return ApiResponseDto.success(SuccessStatus.CHANGE_USER_PW_SUCCESS);
-  }
+    @PostMapping("/find-pw")
+    @Operation(summary = "비밀번호 찾기")
+    public ApiResponseDto<?> findId(@RequestBody FindPwDto findPwDto) {
+        authService.findPw(findPwDto);
+        return ApiResponseDto.success(SuccessStatus.CHANGE_USER_PW_SUCCESS);
+    }
 
-  @PostMapping("/withdrawal")
-  @Operation(summary = "회원 탈퇴")
-  @SecurityRequirement(name = "JWT Auth")
-  public ApiResponseDto<?> withdrawal(
-      @Parameter(hidden = true) @AuthenticationPrincipal User user,
-      @RequestBody MemberDeleteDto memberDeleteDto) {
-    authService.withdrawal(user.getUsername(), memberDeleteDto);
-    return ApiResponseDto.success(SuccessStatus.WITHDRAWAL_SUCCESS);
-  }
+    @PostMapping("/withdrawal")
+    @Operation(summary = "회원 탈퇴")
+    @SecurityRequirement(name = "JWT Auth")
+    public ApiResponseDto<?> withdrawal(
+        @Parameter(hidden = true) @AuthenticationPrincipal User user,
+        @RequestBody MemberDeleteDto memberDeleteDto) {
+        authService.withdrawal(user.getUsername(), memberDeleteDto);
+        return ApiResponseDto.success(SuccessStatus.WITHDRAWAL_SUCCESS);
+    }
 
-  @GetMapping("/dup-check/{userId}")
-  @Operation(summary = "아이디 중복 체크")
-  public ApiResponseDto<?> dupCheck(@PathVariable("userId") String userId) {
-    authService.dupCheck(userId);
-    return ApiResponseDto.success(SuccessStatus.CHECK_USER_ID_SUCCESS);
+    @GetMapping("/dup-check/{userId}")
+    @Operation(summary = "아이디 중복 체크")
+    public ApiResponseDto<?> dupCheck(@PathVariable("userId") String userId) {
+        authService.dupCheck(userId);
+        return ApiResponseDto.success(SuccessStatus.CHECK_USER_ID_SUCCESS);
 
-  }
+    }
 }
diff --git a/src/main/java/com/uspray/uspray/controller/CategoryController.java b/src/main/java/com/uspray/uspray/controller/CategoryController.java
@@ -26,62 +26,62 @@
 
 @RestController
 @RequestMapping("/category")
-@Tag(name = "Category API", description = "Category 관련 API")
+@Tag(name = "Category", description = "Category 관련 API")
 @RequiredArgsConstructor
 @SecurityRequirement(name = "JWT Auth")
 public class CategoryController {
 
-  private final CategoryService categoryService;
+    private final CategoryService categoryService;
 
-  @Operation(summary = "카테고리 조회")
-  @ApiResponse(
-      responseCode = "200",
-      description = "카테고리 조회",
-      content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
-  @PostMapping("/{categoryId}")
-  public ApiResponseDto<CategoryResponseDto> getCategory(
-      @Parameter(hidden = true) @AuthenticationPrincipal User user,
-      @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId
-  ) {
-    return ApiResponseDto.success(SuccessStatus.GET_CATEGORY_SUCCESS,
-        categoryService.getCategory(user.getUsername(), categoryId));
-  }
+    @Operation(summary = "카테고리 조회")
+    @ApiResponse(
+        responseCode = "200",
+        description = "카테고리 조회",
+        content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
+    @PostMapping("/{categoryId}")
+    public ApiResponseDto<CategoryResponseDto> getCategory(
+        @Parameter(hidden = true) @AuthenticationPrincipal User user,
+        @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId
+    ) {
+        return ApiResponseDto.success(SuccessStatus.GET_CATEGORY_SUCCESS,
+            categoryService.getCategory(user.getUsername(), categoryId));
+    }
 
-  @Operation(summary = "카테고리 생성")
-  @ApiResponse(
-      responseCode = "201",
-      description = "카테고리 생성",
-      content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
-  @PostMapping()
-  public ApiResponseDto<CategoryResponseDto> createCategory(
-      @Parameter(hidden = true) @AuthenticationPrincipal User user,
-      @RequestBody @Valid CategoryRequestDto categoryRequestDto
-  ) {
-    return ApiResponseDto.success(SuccessStatus.CREATE_CATEGORY_SUCCESS,
-        categoryService.createCategory(user.getUsername(), categoryRequestDto));
-  }
+    @Operation(summary = "카테고리 생성")
+    @ApiResponse(
+        responseCode = "201",
+        description = "카테고리 생성",
+        content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
+    @PostMapping()
+    public ApiResponseDto<CategoryResponseDto> createCategory(
+        @Parameter(hidden = true) @AuthenticationPrincipal User user,
+        @RequestBody @Valid CategoryRequestDto categoryRequestDto
+    ) {
+        return ApiResponseDto.success(SuccessStatus.CREATE_CATEGORY_SUCCESS,
+            categoryService.createCategory(user.getUsername(), categoryRequestDto));
+    }
 
-  @DeleteMapping("/{categoryId}")
-  public ApiResponseDto<CategoryResponseDto> deleteCategory(
-      @Parameter(hidden = true) @AuthenticationPrincipal User user,
-      @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId
-  ) {
-    return ApiResponseDto.success(SuccessStatus.DELETE_CATEGORY_SUCCESS,
-        categoryService.deleteCategory(user.getUsername(), categoryId));
-  }
+    @DeleteMapping("/{categoryId}")
+    public ApiResponseDto<CategoryResponseDto> deleteCategory(
+        @Parameter(hidden = true) @AuthenticationPrincipal User user,
+        @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId
+    ) {
+        return ApiResponseDto.success(SuccessStatus.DELETE_CATEGORY_SUCCESS,
+            categoryService.deleteCategory(user.getUsername(), categoryId));
+    }
 
-  @PutMapping("/{categoryId}")
-  @ApiResponse(
-      responseCode = "200",
-      description = "카테고리 수정",
-      content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
-  @Operation(summary = "카테고리 수정")
-  public ApiResponseDto<CategoryResponseDto> updatePray(
-      @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId,
-      @RequestBody @Valid CategoryRequestDto categoryRequestDto,
-      @Parameter(hidden = true) @AuthenticationPrincipal User user
-  ) {
-    return ApiResponseDto.success(SuccessStatus.UPDATE_CATEGORY_SUCCESS,
-        categoryService.updateCategory(user.getUsername(), categoryId, categoryRequestDto));
-  }
+    @PutMapping("/{categoryId}")
+    @ApiResponse(
+        responseCode = "200",
+        description = "카테고리 수정",
+        content = @Content(schema = @Schema(implementation = CategoryResponseDto.class)))
+    @Operation(summary = "카테고리 수정")
+    public ApiResponseDto<CategoryResponseDto> updatePray(
+        @Parameter(description = "카테고리 ID", required = true) @PathVariable("categoryId") Long categoryId,
+        @RequestBody @Valid CategoryRequestDto categoryRequestDto,
+        @Parameter(hidden = true) @AuthenticationPrincipal User user
+    ) {
+        return ApiResponseDto.success(SuccessStatus.UPDATE_CATEGORY_SUCCESS,
+            categoryService.updateCategory(user.getUsername(), categoryId, categoryRequestDto));
+    }
 }
diff --git a/src/main/java/com/uspray/uspray/controller/GroupPrayController.java b/src/main/java/com/uspray/uspray/controller/GroupPrayController.java
@@ -28,7 +28,7 @@
 
 @RestController
 @RequestMapping("/grouppray")
-@Tag(name = "GroupPray", description = "모임 기도제목 API")
+@Tag(name = "Group pray", description = "모임 기도제목 API")
 @RequiredArgsConstructor
 @SecurityRequirement(name = "JWT Auth")
 public class GroupPrayController {

diff --git a/src/main/java/com/uspray/uspray/controller/MemberController.java b/src/main/java/com/uspray/uspray/controller/MemberController.java
@@ -1,7 +1,7 @@
 package com.uspray.uspray.controller;
 
-import com.uspray.uspray.DTO.notification.NotificationAgreeDto;
 import com.uspray.uspray.DTO.ApiResponseDto;
+import com.uspray.uspray.DTO.notification.NotificationAgreeDto;
 import com.uspray.uspray.exception.SuccessStatus;
 import com.uspray.uspray.service.MemberService;
 import io.swagger.v3.oas.annotations.Operation;
@@ -22,7 +22,7 @@
 @RequiredArgsConstructor
 @RequestMapping("/member")
 @SecurityRequirement(name = "JWT Auth")
-@Tag(name = "Member API", description = "유저 관련 api")
+@Tag(name = "Member", description = "유저 관련 api")
 public class MemberController {
 
     private final MemberService memberService;