Skip to content

Commit 17f9a12

Browse files
committed
chore: 코드 리뷰 사항 반영
- 예외 메세지 변경 - 컨트롤러와 API 엔드포인트에 스웨거 어노테이션 추가 - 응답 DTO에 스웨거 스키마 추
1 parent cc00129 commit 17f9a12

File tree

3 files changed

+19
-1
lines changed

3 files changed

+19
-1
lines changed

src/main/java/com/somemore/center/controller/CenterQueryApiController.java

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
import com.somemore.center.dto.response.CenterProfileResponseDto;
44
import com.somemore.center.usecase.query.CenterQueryUseCase;
55
import com.somemore.global.common.response.ApiResponse;
6+
import io.swagger.v3.oas.annotations.Operation;
7+
import io.swagger.v3.oas.annotations.tags.Tag;
68
import lombok.RequiredArgsConstructor;
79
import org.springframework.web.bind.annotation.GetMapping;
810
import org.springframework.web.bind.annotation.PathVariable;
@@ -14,10 +16,12 @@
1416
@RequiredArgsConstructor
1517
@RestController
1618
@RequestMapping("/api/center")
19+
@Tag(name = "Center Query API", description = "기관 관련 조회 API를 제공합니다.")
1720
public class CenterQueryApiController {
1821

1922
private final CenterQueryUseCase centerQueryUseCase;
2023

24+
@Operation(summary = "기관 프로필 조회 API")
2125
@GetMapping("/profile/{centerId}")
2226
public ApiResponse<CenterProfileResponseDto> getCenterProfile(@PathVariable UUID centerId) {
2327

src/main/java/com/somemore/center/dto/response/CenterProfileResponseDto.java

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
import com.fasterxml.jackson.databind.annotation.JsonNaming;
55
import com.somemore.center.domain.Center;
66
import com.somemore.center.domain.PreferItem;
7+
import io.swagger.v3.oas.annotations.media.Schema;
78
import lombok.Builder;
89

910
import java.util.List;
@@ -12,12 +13,25 @@
1213
@JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)
1314
@Builder
1415
public record CenterProfileResponseDto(
16+
@Schema(description = "센터 ID", example = "123e4567-e89b-12d3-a456-426614174000")
1517
UUID centerId,
18+
19+
@Schema(description = "센터 이름", example = "서울 도서관")
1620
String name,
21+
22+
@Schema(description = "연락처", example = "010-1234-5678")
1723
String contactNumber,
24+
25+
@Schema(description = "센터 이미지 URL", example = "https://example.com/images/center.jpg")
1826
String imgUrl,
27+
28+
@Schema(description = "센터 소개", example = "저희 도서관은 유명해요")
1929
String introduce,
30+
31+
@Schema(description = "센터 홈페이지 링크", example = "https://fitnesscenter.com")
2032
String homepageLink,
33+
34+
@Schema(description = "선호 물품 리스트")
2135
List<PreferItemResponseDto> preferItems
2236
) {
2337
public static CenterProfileResponseDto of(Center center, List<PreferItemResponseDto> preferItemDtos) {

src/main/java/com/somemore/global/exception/ExceptionMessage.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
@Getter
99
public enum ExceptionMessage {
1010

11-
NOT_EXISTS_CENTER("존재하지 않는 기관 ID 입니다."),
11+
NOT_EXISTS_CENTER("존재하지 않는 기관 입니다."),
1212
NOT_EXISTS_COMMUNITY_BOARD("존재하지 않는 게시글 입니다."),
1313
UNAUTHORIZED_COMMUNITY_BOARD("해당 게시글에 권한이 없습니다."),
1414
NOT_EXISTS_COMMUNITY_COMMENT("존재하지 않는 댓글 입니다."),

0 commit comments

Comments
 (0)