[Java, Spring] 카카오맵 카테고리 검색 Rest API 구현하기

- 새롭게 진행중인 "점심메뉴 추천서비스" 토이 프로젝트에 카카오맵 API를 활용하여 현재 사용자의 위치 근방에 존재하는 음식점들의 정보를 보여줄 수 있게 카카오맵 API 를 활용하였다.

- Js를 사용하면 더욱 간편하게 사용이 가능하지만 서버에서 데이터를 받아와서 화면에 뿌려주는 방식으로 구현하여 추후 기능 업데이트시에 서버에서 데이터를 별도로 가공할 목적으로 카카오맵 API를 Rest하게 사용하도록 구현하였다.

- 모든 코드는 GitHub에서 확인 가능하다

Link : https://github.com/DoHyeonJ/LunchRecommend

1. Controller

package com.lunchrecommend;

import lombok.RequiredArgsConstructor;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;

import javax.servlet.http.HttpServletRequest;

@Controller
@RequiredArgsConstructor
public class LunchController {

    private final LunchService lunchService;

    /**
     * 음식점 추천 List Post 요청
     * @param request 요청 데이터
     * @return ResponseEntity
     */
    @PostMapping("/lunch")
    private ResponseEntity<String> searchLunch(HttpServletRequest request) {
        String latitude = request.getParameter("latitude");
        String longitude = request.getParameter("longitude");
        String page = request.getParameter("page");

        return lunchService.getSearchLunchList(latitude, longitude, page, "15");
    }

    @PutMapping("/lunch")
    private ResponseEntity<String> updateLunch() {
        return ResponseEntity.status(HttpStatus.OK).body("PutMapping!!");
    }

    @DeleteMapping("lunch")
    private ResponseEntity<String> deleteLunch() {
        return ResponseEntity.status(HttpStatus.NO_CONTENT).body("DeleteMapping!!");
    }

}

Controller에서는 "/lunch"라는 url 호출시 동작할 mapping들을 정의해 놓았다.
현재는 PostMapping만 사용하지만 추후 사용성을 대비하여 Put과 Delete도 구현해놓았다.
Url 요청시에 "http://localhost:8080/lunch" 를 호출 할 경우 Http Method를 Post, Put, Delete를 설정하여 호출할 경우를 각각 구현하였다.
필수 파라미터로는 latitude : 위도, longitude : 경도, page : 노출 페이지 수 / 3개의 파라미터를 받게된다.

2. Service

package com.lunchrecommend;

import org.springframework.http.*;
import org.springframework.stereotype.Service;
import org.springframework.web.client.RestTemplate;

import java.util.List;

@Service
public class LunchService {

    /**
     * 좌표 기준 음식점 데이터 조회
     * 파라미터 순서는 x, y 순서로 넘겨줘야 데이터 리턴 받을 수 있음
     * @param longitude 경도 -> x
     * @param latitude 위도 -> y
     * @param page 페이지 수 1,2,3
     * @param size 페이지당 조회 수 15
     * @return ResponseEntity
     */
    public ResponseEntity<String> getSearchLunchList(String longitude, String latitude, String page, String size) {
        HttpHeaders headers = new HttpHeaders();
        headers.setAccept(List.of(MediaType.APPLICATION_JSON));
        headers.setContentType(MediaType.APPLICATION_JSON);
        headers.set("Authorization", "KakaoAK {APIKEY}");

        HttpEntity<String> entity = new HttpEntity<>("", headers);

        String baseUrl = "https://dapi.kakao.com/v2/local/search/category.json?" +
                "category_group_code=FD6" +
                "&page=" + page +
                "&size="+ size +
                "&sort=accuracy" +
                "&x=" + latitude +
                "&y=" + longitude;

        RestTemplate restTemplate = new RestTemplate();

        return restTemplate.exchange(baseUrl, HttpMethod.GET, entity, String.class);
    }

}

위에서 본 Controller에서 Post요청을 통해 getSearchLunchList 메서드를 호출한다.
경도, 위도, 노출 페이지 파라미터는 받았으며, 여기서 따로 설정해줘야 하는 부분은 headers.set을 해주고있는 부분의 {APIKEY}를 넣어줘야 한다.
Key값 얻는법

https://developers.kakao.com/

Kakao Developers

카카오 API를 활용하여 다양한 어플리케이션을 개발해보세요. 카카오 로그인, 메시지 보내기, 친구 API, 인공지능 API 등을 제공합니다.

developers.kakao.com

접속

가입 및 애플리케이션 생성

REST API 키 복사하여 {APIKEY} 영역에 넣기

category_group_code는 카테고리 코드가 들어가야 하며 FD6은 음식점의 코드이다. 다른 카테고리의 코드가 필요하다면 카카오 공식문서를 참고하면 된다.
https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-category