Merge pull request #65 from swyp-app-team-4/feat#64-add-image-url-field-in-official-place-response

[Feat] 공식 장소 Response에 `imageUrl` 추가 및 누락된 Swagger 어노테이션 추가

Author: KOKEONHO

src/main/java/boombimapi/domain/congestion/api/MemberCongestionController.java

@@ -6,6 +6,10 @@
 import boombimapi.domain.congestion.dto.request.CreateMemberCongestionRequest;
 import boombimapi.domain.congestion.dto.response.CreateMemberCongestionResponse;
 import boombimapi.global.response.BaseResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -18,10 +22,15 @@
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/member-congestion")
+@Tag(name = "Member Congestion", description = "사용자 혼잡도 관련 API")
 public class MemberCongestionController {
 
     private final MemberCongestionService memberCongestionService;
 
+    @Operation(summary = "사용자 혼잡도 생성", description = "사용자 장소에 새로운 사용자 혼잡도를 추가합니다.")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "사용자 혼잡도 생성 성공")
+    })
     @PostMapping("/create")
     public ResponseEntity<BaseResponse<CreateMemberCongestionResponse>> createMemberCongestion(
         @AuthenticationPrincipal String memberId,
@@ -37,5 +46,4 @@ public ResponseEntity<BaseResponse<CreateMemberCongestionResponse>> createMember
     }
 
 
-
 }

src/main/java/boombimapi/domain/favorite/api/FavoriteController.java

@@ -7,6 +7,10 @@
 import boombimapi.domain.favorite.dto.response.AddFavoriteResponse;
 import boombimapi.domain.favorite.dto.response.GetFavoriteResponse;
 import boombimapi.global.response.BaseResponse;
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.responses.ApiResponse;
+import io.swagger.v3.oas.annotations.responses.ApiResponses;
+import io.swagger.v3.oas.annotations.tags.Tag;
 import java.util.List;
 import lombok.RequiredArgsConstructor;
 import org.springframework.http.HttpStatus;
@@ -23,10 +27,15 @@
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/favorite")
+@Tag(name = "Favorite", description = "사용자 즐겨찾기 관련 API")
 public class FavoriteController {
 
     private final FavoriteService favoriteService;
 
+    @Operation(summary = "즐겨찾기 추가", description = "해당 장소를 즐겨찾기에 추가합니다.")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "즐겨찾기 추가 성공")
+    })
     @PostMapping
     public ResponseEntity<BaseResponse<AddFavoriteResponse>> addFavorite(
         @AuthenticationPrincipal String memberId,
@@ -41,6 +50,10 @@ public ResponseEntity<BaseResponse<AddFavoriteResponse>> addFavorite(
         );
     }
 
+    @Operation(summary = "즐겨찾기 삭제", description = "해당 장소를 즐겨찾기에서 삭제합니다.")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "즐겨찾기 삭제 성공")
+    })
     @DeleteMapping
     public ResponseEntity<BaseResponse<Void>> deleteFavorite(
         @AuthenticationPrincipal String memberId,
@@ -57,6 +70,10 @@ public ResponseEntity<BaseResponse<Void>> deleteFavorite(
         );
     }
 
+    @Operation(summary = "즐겨찾기 조회", description = "사용자가 즐겨찾기한 장소들의 최신 혼잡도를 조회합니다.")
+    @ApiResponses(value = {
+        @ApiResponse(responseCode = "200", description = "사용자 즐겨찾기 최신 혼잡도 조회 성공")
+    })
     @GetMapping
     public ResponseEntity<BaseResponse<List<GetFavoriteResponse>>> getFavorites(
         @AuthenticationPrincipal String memberId

src/main/java/boombimapi/domain/place/application/OfficialPlaceService.java

@@ -88,13 +88,19 @@ public List<ViewportResponse> getOfficialPlacesInViewport(
                 centroidLongitude
             );
 
-            result.add(new ViewportResponse(
-                officialPlace.getId(),
-                officialPlace.getName(),
-                new Coordinate(centroidLatitude, centroidLongitude),
-                distanceMeters,
-                congestionLevel.getName(),
-                congestionLevel.getMessage()));
+            Coordinate coordinate = Coordinate.of(centroidLatitude, centroidLongitude);
+
+            result.add(
+                ViewportResponse.of(
+                    officialPlace.getId(),
+                    officialPlace.getName(),
+                    officialPlace.getImageUrl(),
+                    coordinate,
+                    distanceMeters,
+                    congestionLevel.getName(),
+                    congestionLevel.getMessage()
+                )
+            );
         }
 
         // TODO: 정렬을 DB 단에서 해줄지, 아니면 지금처럼 소스 코드 단에서 해줄지 고민
@@ -130,10 +136,11 @@ public OfficialPlaceOverviewResponse getOverview(
             .map(OfficialPlaceForecast::from)
             .toList();
 
-        return new OfficialPlaceOverviewResponse(
+        return OfficialPlaceOverviewResponse.of(
             officialPlace.getId(),
             officialPlace.getName(),
             officialPlace.getPoiCode(),
+            officialPlace.getImageUrl(),
             latestOfficialCongestion.getObservedAt(),
             officialPlace.getCentroidLatitude(),
             officialPlace.getCentroidLongitude(),

src/main/java/boombimapi/domain/place/dto/response/ViewportResponse.java

@@ -3,12 +3,33 @@
 import boombimapi.global.dto.Coordinate;
 
 public record ViewportResponse(
-    Long id,
-    String name,
+    Long officialPlaceId,
+    String officialPlaceName,
+    String imageUrl,
     Coordinate coordinate,
     double distance,
     String congestionLevelName,
     String congestionMessage
 ) {
 
+    public static ViewportResponse of(
+        Long officialPlaceId,
+        String officialPlaceName,
+        String imageUrl,
+        Coordinate coordinate,
+        double distance,
+        String congestionLevelName,
+        String congestionMessage
+    ) {
+        return new ViewportResponse(
+            officialPlaceId,
+            officialPlaceName,
+            imageUrl,
+            coordinate,
+            distance,
+            congestionLevelName,
+            congestionMessage
+        );
+    }
+
 }

src/main/java/boombimapi/domain/place/dto/response/official/OfficialPlaceOverviewResponse.java

@@ -4,9 +4,10 @@
 import java.util.List;
 
 public record OfficialPlaceOverviewResponse(
-    Long id,
-    String name,
+    Long officialPlaceId,
+    String officialPlaceName,
     String poiCode,
+    String imageUrl,
     LocalDateTime observedAt,
     Double centroidLatitude,
     Double centroidLongitude,
@@ -15,4 +16,30 @@ public record OfficialPlaceOverviewResponse(
     List<OfficialPlaceForecast> forecasts
 ) {
 
+    public static OfficialPlaceOverviewResponse of(
+        Long officialPlaceId,
+        String officialPlaceName,
+        String poiCode,
+        String imageUrl,
+        LocalDateTime observedAt,
+        Double centroidLatitude,
+        Double centroidLongitude,
+        String polygonCoordinates,
+        List<OfficialPlaceDemographics> demographics,
+        List<OfficialPlaceForecast> forecasts
+    ) {
+        return new OfficialPlaceOverviewResponse(
+            officialPlaceId,
+            officialPlaceName,
+            poiCode,
+            imageUrl,
+            observedAt,
+            centroidLatitude,
+            centroidLongitude,
+            polygonCoordinates,
+            demographics,
+            forecasts
+        );
+    }
+
 }

src/main/java/boombimapi/global/dto/Coordinate.java

@@ -5,4 +5,11 @@ public record Coordinate(
     double longitude
 ) {
 
+    public static Coordinate of(
+        double latitude,
+        double longitude
+    ) {
+        return new Coordinate(latitude, longitude);
+    }
+
 }

src/main/resources/application-prod.yml

@@ -12,7 +12,7 @@ spring:
     password: ${DB_PASSWORD}
   jpa:
     hibernate:
-      ddl-auto: none
+      ddl-auto: create
     properties:
       hibernate:
         default_schema: root        # 기본 스키마