[FEAT] 도보 최적 경로 API

build.gradle

@@ -50,6 +50,9 @@ dependencies {
 	testImplementation 'org.springframework.security:spring-security-test'
 	testCompileOnly 'org.projectlombok:lombok'
 	testRuntimeOnly 'org.junit.platform:junit-platform-launcher'
+
+	// web client
+	implementation 'org.springframework.boot:spring-boot-starter-webflux'
 }
 
 tasks.named('test') {

src/main/java/com/wayble/server/ServerApplication.java

@@ -1,8 +1,10 @@
 package com.wayble.server;
 
+import com.wayble.server.direction.external.tmap.TMapProperties;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.autoconfigure.data.elasticsearch.ReactiveElasticsearchRepositoriesAutoConfiguration;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.data.elasticsearch.repository.config.EnableElasticsearchRepositories;
 import org.springframework.data.jpa.repository.config.EnableJpaAuditing;
 
@@ -11,6 +13,7 @@
 )
 @EnableJpaAuditing
 @EnableElasticsearchRepositories(basePackages = "com.wayble.server.explore.repository")
+@EnableConfigurationProperties(TMapProperties.class)
 public class ServerApplication {
 
 	public static void main(String[] args) {

src/main/java/com/wayble/server/common/config/WebClientConfig.java

@@ -0,0 +1,27 @@
+package com.wayble.server.common.config;
+
+import com.wayble.server.direction.external.tmap.TMapProperties;
+import lombok.RequiredArgsConstructor;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.web.reactive.function.client.WebClient;
+
+@Configuration
+@RequiredArgsConstructor
+public class WebClientConfig {
+
+    private final TMapProperties tMapProperties;
+
+    @Bean
+    public WebClient webClient() {
+        return WebClient.builder()
+                .build();
+    }
+
+    @Bean
+    public WebClient tMapWebClient() {
+        return WebClient.builder()
+                .baseUrl(tMapProperties.baseUrl())
+                .build();
+    }
+}

src/main/java/com/wayble/server/direction/controller/WalkingController.java

@@ -0,0 +1,34 @@
+package com.wayble.server.direction.controller;
+
+import com.wayble.server.common.response.CommonResponse;
+import com.wayble.server.direction.controller.swagger.WalkingSwagger;
+import com.wayble.server.direction.external.tmap.dto.request.TMapRequest;
+import com.wayble.server.direction.external.tmap.dto.response.TMapParsingResponse;
+import com.wayble.server.direction.service.WalkingService;
+import lombok.RequiredArgsConstructor;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestParam;
+import org.springframework.web.bind.annotation.RestController;
+
+@RestController
+@RequiredArgsConstructor
+@RequestMapping("/api/v1/directions/walking")
+public class WalkingController implements WalkingSwagger {
+
+    private final WalkingService walkingService;
+
+    @Override
+    @GetMapping()
+    public CommonResponse<TMapParsingResponse> callTMapApi(
+            @RequestParam double startX,
+            @RequestParam double startY,
+            @RequestParam double endX,
+            @RequestParam double endY,
+            @RequestParam String startName,
+            @RequestParam String endName
+    ) {
+        TMapRequest request = new TMapRequest(startX, startY, endX, endY, startName, endName);
+        return CommonResponse.success(walkingService.callTMapApi(request));
+    }
+}

src/main/java/com/wayble/server/direction/controller/swagger/WalkingSwagger.java

@@ -0,0 +1,31 @@
+package com.wayble.server.direction.controller.swagger;
+
+import com.wayble.server.common.response.CommonResponse;
+import com.wayble.server.direction.external.tmap.dto.response.TMapParsingResponse;
+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 org.springframework.web.bind.annotation.RequestParam;
+
+@Tag(name = "[도보]", description = "도보 길찾기 관련 API")
+public interface WalkingSwagger {
+    @Operation(
+            summary = "도보 최적 경로 길찾기 API",
+            description = "T MAP API를 호출하여 도보 최적 경로 길찾기를 진행합니다."
+    )
+    @ApiResponses(value = {
+            @ApiResponse(
+                    responseCode = "200",
+                    description = "T MAP API 호출이 성공적으로 실행되었습니다."
+            )
+    })
+    CommonResponse<TMapParsingResponse> callTMapApi(
+            @RequestParam double startX,
+            @RequestParam double startY,
+            @RequestParam double endX,
+            @RequestParam double endY,
+            @RequestParam String startName,
+            @RequestParam String endName
+    );
+}

src/main/java/com/wayble/server/direction/exception/WalkingErrorCase.java

@@ -0,0 +1,17 @@
+package com.wayble.server.direction.exception;
+
+import com.wayble.server.common.exception.ErrorCase;
+import lombok.Getter;
+import lombok.RequiredArgsConstructor;
+
+@Getter
+@RequiredArgsConstructor
+public enum WalkingErrorCase implements ErrorCase {
+
+    T_MAP_API_FAILED(500, 8001, "T MAP API 호출에 실패했습니다."),
+    ;
+
+    private final Integer httpStatusCode;
+    private final Integer errorCode;
+    private final String message;
+}

src/main/java/com/wayble/server/direction/external/tmap/TMapClient.java

@@ -0,0 +1,27 @@
+package com.wayble.server.direction.external.tmap;
+
+import com.wayble.server.direction.external.tmap.dto.request.TMapRequest;
+import com.wayble.server.direction.external.tmap.dto.response.TMapResponse;
+import lombok.RequiredArgsConstructor;
+import org.springframework.http.MediaType;
+import org.springframework.stereotype.Component;
+import org.springframework.web.reactive.function.client.WebClient;
+
+@Component
+@RequiredArgsConstructor
+public class TMapClient {
+
+    private final WebClient tMapWebClient;
+    private final TMapProperties tMapProperties;
+
+    public TMapResponse response(TMapRequest request) {
+        return tMapWebClient.post()
+                .uri(tMapProperties.baseUrl())
+                .header("appKey", tMapProperties.secretKey())
+                .contentType(MediaType.APPLICATION_JSON)
+                .bodyValue(request)
+                .retrieve()
+                .bodyToMono(TMapResponse.class)
+                .block();
+    }
+}

src/main/java/com/wayble/server/direction/external/tmap/TMapProperties.java

@@ -0,0 +1,10 @@
+package com.wayble.server.direction.external.tmap;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties(prefix = "tmap")
+public record TMapProperties(
+        String secretKey,
+        String baseUrl
+) {
+}

src/main/java/com/wayble/server/direction/external/tmap/dto/request/TMapRequest.java

@@ -0,0 +1,14 @@
+package com.wayble.server.direction.external.tmap.dto.request;
+
+import lombok.Builder;
+
+@Builder
+public record TMapRequest(
+        double startX,
+        double startY,
+        double endX,
+        double endY,
+        String startName,
+        String endName
+) {
+}

src/main/java/com/wayble/server/direction/external/tmap/dto/response/TMapParsingResponse.java

@@ -0,0 +1,74 @@
+package com.wayble.server.direction.external.tmap.dto.response;
+
+import io.swagger.v3.oas.annotations.media.Schema;
+import lombok.Builder;
+
+import java.util.List;
+
+@Builder
+@Schema(description = "도보 최적 경로 T MAP API")
+public record TMapParsingResponse(
+        @Schema(description = "총 거리", example = "909")
+        int totalDistance,
+
+        @Schema(description = "총 소요 시간", example = "676")
+        int totalTime,
+
+        @Schema(
+                description = "경로 단계",
+                example = "[{\"type\":\"point\",\"name\":\"강남역\",\"description\":\"보행자도로를 따라 32m 이동\"}]"
+        )
+        List<Step> steps
+) {
+
+    @Schema(description = "경로 단계")
+    public record Step(
+            @Schema(description = "단계 타입 (point - 지점, line - 도로)", example = "point")
+            String type,
+
+            @Schema(description = "지점 또는 도로명", example = "강남역")
+            String name,
+
+            @Schema(
+                    description = "설명",
+                    example = "강남역에서 좌측 횡단보도를 건넌 후 보행자도로를 따라 32m 이동"
+            )
+            String description,
+
+            @Schema(
+                    description = "해당 포인트 좌표 (type - point)",
+                    example = "{\"longitude\":127.0241571,\"latitude\":37.5037355}"
+            )
+            Coordinate coordinate,
+
+            @Schema(
+                    description = "좌표 리스트 (type - line)",
+                    example = "[{\"longitude\":127.0241571,\"latitude\":37.5037355},{\"longitude\":127.0315678,\"latitude\":37.5067709}]"
+            )
+            List<Coordinate> coordinates,
+
+            @Schema(description = "턴 타입", example = "212")
+            Integer turnType,
+
+            @Schema(
+                    description = "포인트 타입 (SP - 출발, EP - 도착, GP - 경유지)",
+                    example = "SP"
+            )
+            String pointType,
+
+            @Schema(description = "해당 구간 거리", example = "32")
+            Integer distance,
+
+            @Schema(description = "해당 구간 소요 시간", example = "21")
+            Integer time
+    ) {}
+
+    @Schema(description = "좌표")
+    public record Coordinate(
+            @Schema(description = "경도", example = "127.02415714643489")
+            double longitude,
+
+            @Schema(description = "위도", example = "37.503735591581")
+            double latitude
+    ) {}
+}

src/main/java/com/wayble/server/direction/external/tmap/dto/response/TMapResponse.java

@@ -0,0 +1,43 @@
+package com.wayble.server.direction.external.tmap.dto.response;
+
+import java.util.List;
+
+public record TMapResponse(
+        String type,
+        List<Feature> features
+) {
+
+    public record Feature(
+            String type,
+            Geometry geometry,
+            Properties properties
+    ) {}
+
+    public record Geometry(
+            String type,
+            List<Object> coordinates
+    ) {}
+
+    public record Properties(
+            Integer totalDistance,
+            Integer totalTime,
+            Integer index,
+            Integer pointIndex,
+            String name,
+            String description,
+            String direction,
+            String nearPoiName,
+            String nearPoiX,
+            String nearPoiY,
+            String intersectionName,
+            String facilityType,
+            String facilityName,
+            Integer turnType,
+            String pointType,
+            Integer distance,
+            Integer time,
+            Integer roadType,
+            Integer categoryRoadType,
+            Integer lineIndex
+    ) {}
+}