kakao-local-search v0.0.11

카카오 로컬 검색 api 사용하기 위한 함수들

은근 자꾸 쓰는 일이 생겨서 개인용 + 패키지 연습용 으로 만든 패키지입니다.

사용법

카카오 개발자 REST API 키가 필요합니다.

https://developers.kakao.com/

가입 후 앱 생성하여 REST API 키를 받으면, 프로젝트 폴더에 .env 파일을 만들고

1. node

KAKAO_REST_KEY=[--------------------------------]

2. Create-React-App. 브라우저에서 바로 사용하려는 경우. js파일에 키값이 들어가기 때문에 주의 필요. 테스트 용도로만 사용 권장.

REACT_APP_KAKAO_REST_KEY=[--------------------------------]

형식으로 입력해줘야 제대로 작동합니다. (대괄호는 실제로 입력할 필요 없음)

kakaoAddrDirect

import { kakaoAddrDirect } from 'kakao-local-search'

kakaoAddrDirect('중화동').then(console.log)

// [
//   {
//     address: {
//       address_name: '서울 중랑구 중화동',
//       b_code: '1126010300',
//       h_code: '',
//       main_address_no: '',
//       mountain_yn: 'N',
//       region_1depth_name: '서울',
//       region_2depth_name: '중랑구',
//       region_3depth_h_name: '',
//       region_3depth_name: '중화동',
//       sub_address_no: '',
//       x: '127.077320262185',
//       y: '37.5994618167452'
//     },
//     address_name: '서울 중랑구 중화동',
//     address_type: 'REGION',
//     road_address: null,
//     x: '127.077320262185',
//     y: '37.5994618167452'
//   },
//   ...
// ]

kakaoPlaceDirect

import { kakaoPlaceDirect } from 'kakao-local-search'

kakaoPlaceDirect('대한곱창').then(console.log)

// [
//   {
//     address_name: '경북 구미시 선산읍 완전리 195-2',
//     category_group_code: 'FD6',
//     category_group_name: '음식점',
//     category_name: '음식점 > 한식 > 육류,고기 > 곱창,막창',
//     distance: '',
//     id: '26991998',
//     phone: '054-482-0193',
//     place_name: '대한곱창',
//     place_url: 'http://place.map.kakao.com/26991998',
//     road_address_name: '경북 구미시 선산읍 남문로5길 13',
//     x: '128.30016334026996',
//     y: '36.241573803600716'
//   },
//   {
//     address_name: '서울 광진구 능동 221-2',
//     category_group_code: 'FD6',
//     category_group_name: '음식점',
//     category_name: '음식점 > 한식 > 육류,고기 > 곱창,막창',
//     distance: '',
//     id: '27229388',
//     phone: '02-456-5207',
//     place_name: '군자대한곱창 본점',
//     place_url: 'http://place.map.kakao.com/27229388',
//     road_address_name: '서울 광진구 능동로36길 10',
//     x: '127.07968386445',
//     y: '37.5561728890469'
//   },
//   ...
// ]

kakaoAddrAsyncContextByKey / kakaoPlaceAsyncContextByKey

import Koa from 'koa'
import Router from 'koa-router'
import {
  kakaoAddrAsyncContextByKey,
  kakaoPlaceAsyncContextByKey,
} from 'kakao-local-search'

const app = new Koa()

const api = new Router()
api.get('/kakao-addr', kakaoAddrAsyncContextByKey('keyword'))
api.get('/kakao-place', kakaoPlaceAsyncContextByKey('keyword'))

app.use(api.routes())

app.listen(4000)

// http://localhost:4000/kakao-addr?keyword=일원동
// [{"address":{"address_name":"서울 강남구 일원동","b_code":"1168011400","h_code":"","main_address_no":"","mountain_yn":"N","region_1depth_name":"서울","region_2depth_name":"강남구","region_3depth_h_name":"","region_3depth_name":"일원동","sub_address_no":"","x":"127.080430036811","y":"37.4795654903151"},"address_name":"서울 강남구 일원동","address_type":"REGION","road_address":null,"x":"127.080430036811","y":"37.4795654903151"}, ...]

// http://localhost:4000/kakao-place?keyword=일원동
// => [{"address_name":"서울 강남구 일원동","category_group_code":"AT4","category_group_name":"관광명소","category_name":"여행 > 관광,명소 > 산","distance":"","id":"10241368","phone":"","place_name":"대모산","place_url":"http://place.map.kakao.com/10241368","road_address_name":"","x":"127.0790106835936","y":"37.47482803960479"}, ...]

참고

1. 주소검색 - https://developers.kakao.com/docs/latest/ko/local/dev-guide#address-coord
2. 키워드로 장소검색 - https://developers.kakao.com/docs/latest/ko/local/dev-guide#search-by-keyword

(TODO)

1. 브라우저 환경에서 사용하려면 웹팩 설정을 통해 넣어줘야 한다고 하는데, 좀 더 쉽게 사용할 수 있는 방법이 있는지 찾아봐야 할 것 같음.(지금은... node_modules 에 kakao-local-search 에 들어가서 AUTH_templet.js 파일에 키값을 직접 넣어줘야 하는데. Node 패키지를 새로 깔거나 하면 지워짐.) Create-React-App 한정 .env 에 "REACT_APP_" prefix 환경변수값으로 브라우저에서 사용 가능. 키 노출될 수 있으니 주의 필요. 어지간하면 서버에서 처리해야 하는게 맞는 듯.

2. index.js 타입스크립트로 바꾸고, typescript 노드 서버로도 테스트 해봐야 함.