Open API 활용하여 공휴일 정보 DB에 저장 및 불러오기 with request module 🍀

🍀 Open API 활용하여 공휴일 정보 저장 및 불러오기 with request module 

⌛ Problem

사용자에게 예약 관련 서비스를 제공하려고 할 때, 모든 공휴일 날짜를 알고 있어야만

공휴일에 예약이 불가능하도록 설정할 수 있을 것입니다.

어떻게 하면 모든 공휴일 날짜를 DB에 저장하고 이를 활용할 수 있을까요?
인터넷에서 모든 공휴일을 찾아서 DB에 하나씩 입력하면 될까요?
물론 그렇게 할 수 있겠지만 너무 별로인 거 같아요.. 😕
방법을 찾아보았습니다.

📜 Solution

한국천문연구원_특일 정보

검색 중 공휴일 관련 오픈 API가 있음을 찾게 되었고 
위 링크에서 Open API를 발급받아 API를 Post Man을 활용해 요청해 보았습니다.

쿼리 스트링으로 연도와 월을 설정할 수 있었고

설정한 기간에 맞는 공휴일을 모두 보여주는 형식의 API였습니다.

 

request

저는 이를 request 모듈을 활용하여 요청받은 값을 파싱 하여

공휴일 날짜를 전부 DB에 저장하고자 하였습니다.

위 링크는 request 모듈에 대한 설명입니다.

 

 

npm i request

request 모듈을 설치하지 않았다면 위 명령어를 통해 request모듈을 설치해 줍니다.

 

 

        const {solYear, solMonth} = req.query;       

        .....    
        ~

        let request = require('request'); //request를 사용할 것임을 명시해 줍니다.
        let options = {
            'method' : 'GET',
            'url'    : 'http://apis.data.go.kr/B090041/openapi/service/SpcdeInfoService/getRestDeInfo?solYear=' + solYear + '&solMonth=' + solMonth + '&_type=json&ServiceKey=' + secret_config.holidayOpenAPISecretKey,
            'headers': {}
        };
        
        let holidayList = [];
        request(options, async function (error, response, body) {
            if (error) {
                throw new Error(error);
            }
            let info = JSON.parse(body);

            if (solMonth == '01' || solMonth == '02' || solMonth == '05' || solMonth == '09' || solMonth == '10') {
                for (i in info['response']['body']['items']['item']) {
                    let holidayName = info['response']['body']['items']['item'][i]['dateName'];
                    let holidayDate = info['response']['body']['items']['item'][i]['locdate'];
                    holidayList.push([holidayName, holidayDate])
                }
            } else {
                let holidayName = info['response']['body']['items']['item']['dateName'];
                let holidayDate = info['response']['body']['items']['item']['locdate'];
                holidayList.push([holidayName, holidayDate])
            }

            if (holidayList.length > 0) {
                await reservationDao.postHoliday(connection, [holidayList]);
            }
        });

async function postHoliday(connection, [values]) {
    const postHolidayQuery = `
        INSERT INTO Holiday (holidayName, holidayDate)
        VALUES ?
    `;
    const [postHolidayRow] = await connection.query(
        postHolidayQuery,
        [values]
    );
    return postHolidayRow;
}

위 코드처럼 연도와 월을 쿼리 스트링으로 입력받아

해당 월의 모든 공휴일을 DB에 저장할 수 있도록 API를 설계했습니다.

 

실제 저장된 데이터들입니다. 2021년 8월부터 2022년 12월까지의 모든 공휴일들을 저장했습니다.

공휴일로 등록된 대통령 선거와 전국 동시 지방선거가 눈에 띄네요.

이제 앞으로 저는 공휴일을 추가할 때 위처럼 직접 설계한 API를 사용하기만 하면 됩니다.

😄 추가적인 활용법

SELECT holidayName, DATE_FORMAT(holidayDate, "%Y-%m-%d") AS holiday
FROM Holiday
WHERE DATE_FORMAT(holidayDate, "%Y-%m") = ?

이렇게 저장된 공휴일 날짜를 바탕으로 예약 기능 API를 설계할 때
클라이언트가 '특정 월의 공휴일을 알려줘'라고 요청한다면

위처럼 쿼리를 설계하여 저장하고 있는 특정 월의 공휴일 날짜를 제공하기만 하면 됩니다.

이렇게 날짜를 제공한다면 프론트 쪽에서 이 날짜는 예약이 불가능하도록 손쉽게 처리할 수 있겠네요.