Feat: Merge branch 'feat/disaster_text' into dev-check

Team-NumberOne · Nov 3, 2023 · a3918cb · a3918cb
2 parents e20488c + 744f6bb
commit a3918cb
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 1 deletion.
diff --git a/src/main/java/com/numberone/backend/domain/disaster/controller/DisasterController.java b/src/main/java/com/numberone/backend/domain/disaster/controller/DisasterController.java
@@ -3,16 +3,28 @@
 import com.numberone.backend.domain.disaster.dto.request.LatestDisasterRequest;
 import com.numberone.backend.domain.disaster.dto.response.LatestDisasterResponse;
 import com.numberone.backend.domain.disaster.service.DisasterService;
+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 = "disasters", description = "재난문자 관련 API")
 @RestController
 @RequiredArgsConstructor
 @RequestMapping("/api/disaster")
 public class DisasterController {
     private final DisasterService disasterService;
+
+    @Operation(summary = "유저와 관련된 가장 최근 재난 문자 가져오기", description =
+            """
+                    현재 유저의 GPS 정보와 유저가 등록한 지역을 기준으로 가장 최근 재난 문자에 대한 정보를 가져옵니다.
+                    
+                    유저의 GPS 정보는 api 요청시에 위도(latitude), 경도(longitude)를 body에 담아 전달해주세요.
+                    
+                    유저가 등록한 지역은 유저가 인증을 위해 같이 보내야하는 jwt 토큰으로부터 알아서 추출해서 처리할 것입니다. 
+                    """)
     @PostMapping("/latest")
-    public LatestDisasterResponse getLatestDisaster(@RequestBody LatestDisasterRequest latestDisasterRequest){
+    public LatestDisasterResponse getLatestDisaster(@RequestBody LatestDisasterRequest latestDisasterRequest) {
         return disasterService.getLatestDisaster(latestDisasterRequest);
     }
 }
diff --git a/src/main/java/com/numberone/backend/domain/disaster/dto/response/LatestDisasterResponse.java b/src/main/java/com/numberone/backend/domain/disaster/dto/response/LatestDisasterResponse.java
@@ -2,17 +2,23 @@
 
 import com.numberone.backend.domain.disaster.entity.Disaster;
 import com.numberone.backend.domain.disaster.util.DisasterType;
+import io.swagger.v3.oas.annotations.media.Schema;
 import lombok.*;
 
 @Getter
 @NoArgsConstructor(access = AccessLevel.PROTECTED)
 @AllArgsConstructor
 @Builder
 public class LatestDisasterResponse {
+    @Schema(defaultValue = "화재")
     private String disasterType;
+    @Schema(defaultValue = "2")
     private Integer severity;
+    @Schema(defaultValue = "서울특별시 강남구 동작동 화재 발생")
     private String title;
+    @Schema(defaultValue = "금일 10.23. 19:39경 소촌동 855 화재 발생, 인근주민은 안전유의 및 차량우회바랍니다. 960-8222")
     private String msg;
+    @Schema(defaultValue = "서울특별시 강남구 ・ 오후 2시 46분")
     private String info;
 
     public static LatestDisasterResponse of(Disaster disaster) {