diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/ad/api/AdController.java b/src/main/java/org/devkor/apu/saerok_server/domain/ad/api/AdController.java index f71bd933..67bc1278 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/ad/api/AdController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/ad/api/AdController.java @@ -23,7 +23,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -@Tag(name = "Ad API", description = "클라이언트 광고 노출 및 이벤트 API") +@Tag(name = "Ads API", description = "클라이언트 광고 노출 및 이벤트 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/ad") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/announcement/api/AnnouncementController.java b/src/main/java/org/devkor/apu/saerok_server/domain/announcement/api/AnnouncementController.java index 72d83a80..34ef70b0 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/announcement/api/AnnouncementController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/announcement/api/AnnouncementController.java @@ -15,7 +15,7 @@ import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RestController; -@Tag(name = "Announcement API", description = "서비스 공지사항 조회 API") +@Tag(name = "Announcements API", description = "서비스 공지사항 조회 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/announcements") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/AuthController.java b/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/AuthController.java index 1f5176c2..deb5c7f5 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/AuthController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/AuthController.java @@ -33,7 +33,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Auth API", description = "소셜 인증 관련 API") +@Tag(name = "Authentication API", description = "소셜 인증 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/auth/") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/LocalAuthController.java b/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/LocalAuthController.java index a9be6262..dec27c1f 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/LocalAuthController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/auth/api/LocalAuthController.java @@ -14,7 +14,7 @@ @RestController @RequestMapping("${api_prefix}/local/") @RequiredArgsConstructor -@Tag(name = "로컬 테스트", description = "로컬 개발환경 전용 API") +@Tag(name = "Local Test API", description = "로컬 개발환경 전용 API") public class LocalAuthController { private final LocalLoginService localLoginService; diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/BirdIdSuggestionController.java b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/BirdIdSuggestionController.java index f2e7637f..492ddb9a 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/BirdIdSuggestionController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/BirdIdSuggestionController.java @@ -18,7 +18,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Bird‑ID Suggestion API", description = "조류 ID 동정 의견 관련 API") +@Tag(name = "Bird ID Suggestions API", description = "조류 ID 동정 의견 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/collections") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentController.java b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentController.java index a8ac057e..a8e9be3c 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentController.java @@ -22,7 +22,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Collection Comment API", description = "컬렉션 댓글 관련 API") +@Tag(name = "Collection Comments API", description = "컬렉션 댓글 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/collections") @@ -151,4 +151,4 @@ public GetCollectionCommentCountResponse getCommentCount( ) { return commentQueryService.getCommentCount(collectionId); } -} \ No newline at end of file +} diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentLikeController.java b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentLikeController.java index f0e9a38f..74cc0dd2 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentLikeController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentLikeController.java @@ -16,7 +16,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Collection Comment API", description = "컬렉션 댓글 관련 API") +@Tag(name = "Collection Comments API", description = "컬렉션 댓글 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/collections/comments") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentReportController.java b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentReportController.java index b2f9d73c..5d286394 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentReportController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/collection/api/CollectionCommentReportController.java @@ -15,7 +15,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Collection Comment API", description = "컬렉션 댓글 관련 API") +@Tag(name = "Collection Comments API", description = "컬렉션 댓글 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/collections") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostCommentReportController.java b/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostCommentReportController.java index bea94133..23102e9e 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostCommentReportController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostCommentReportController.java @@ -15,7 +15,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "FreeBoard Comment API", description = "자유게시판 댓글 관련 API") +@Tag(name = "Free Board API", description = "자유게시판 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/community/freeboard/posts") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostReportController.java b/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostReportController.java index c55642a7..bf4e949d 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostReportController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/freeboard/api/FreeBoardPostReportController.java @@ -15,7 +15,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "FreeBoard API", description = "자유게시판 관련 API") +@Tag(name = "Free Board API", description = "자유게시판 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/community/freeboard/posts") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/mock/api/UserBlockController.java b/src/main/java/org/devkor/apu/saerok_server/domain/mock/api/UserBlockController.java index d0e66d87..3ab475c6 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/mock/api/UserBlockController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/mock/api/UserBlockController.java @@ -17,7 +17,7 @@ import java.time.LocalDateTime; import java.util.List; -@Tag(name = "User Block API", description = "사용자 차단 API (Mock)") +@Tag(name = "User Blocks API", description = "사용자 차단 API (Mock)") @RestController @PreAuthorize("permitAll()") @RequestMapping("${api_prefix}/users/blocks") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationController.java b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationController.java index c7516cbd..33908dda 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationController.java @@ -18,7 +18,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Notification API", description = "알림 관련 API") +@Tag(name = "Notifications API", description = "알림 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/notifications") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationSettingController.java b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationSettingController.java index 101090ab..19ef1b2d 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationSettingController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/NotificationSettingController.java @@ -21,7 +21,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Notification API", description = "알림 관련 API") +@Tag(name = "Notifications API", description = "알림 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/notifications/settings") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/UserDeviceController.java b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/UserDeviceController.java index 156fec7e..513f2fc7 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/UserDeviceController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/notification/api/UserDeviceController.java @@ -16,7 +16,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Notification API", description = "알림 관련 API") +@Tag(name = "Notifications API", description = "알림 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/notifications/tokens") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/profile/api/ProfileController.java b/src/main/java/org/devkor/apu/saerok_server/domain/profile/api/ProfileController.java index e6b7ea17..04be8a06 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/profile/api/ProfileController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/profile/api/ProfileController.java @@ -14,7 +14,7 @@ import org.springframework.security.core.annotation.AuthenticationPrincipal; import org.springframework.web.bind.annotation.*; -@Tag(name = "Profile API", description = "사용자 프로필 조회") +@Tag(name = "Profiles API", description = "사용자 프로필 조회") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/profile") diff --git a/src/main/java/org/devkor/apu/saerok_server/domain/user/api/UserController.java b/src/main/java/org/devkor/apu/saerok_server/domain/user/api/UserController.java index df931a60..ed54a942 100644 --- a/src/main/java/org/devkor/apu/saerok_server/domain/user/api/UserController.java +++ b/src/main/java/org/devkor/apu/saerok_server/domain/user/api/UserController.java @@ -25,7 +25,7 @@ import org.springframework.web.bind.annotation.*; import org.springframework.http.HttpStatus; -@Tag(name = "User API", description = "회원 정보 관련 API") +@Tag(name = "Users API", description = "회원 정보 관련 API") @RestController @RequiredArgsConstructor @RequestMapping("${api_prefix}/user/") diff --git a/src/main/resources/application.yml b/src/main/resources/application.yml index 038ef17a..a7f34caf 100644 --- a/src/main/resources/application.yml +++ b/src/main/resources/application.yml @@ -53,4 +53,11 @@ notification-batch: max-batches-per-tick: 300 springdoc: - use-fqn: true \ No newline at end of file + use-fqn: true + paths-to-exclude: + - ${api_prefix}/admin/** + swagger-ui: + tags-sorter: alpha + operations-sorter: method + doc-expansion: list + filter: true