[.Net] C#에서 Open API 고속도로 교통량 정보 얻기 (예제 포함)

소개

저는 머신 비전 분야에 근무하고 있고, 주로 비전 관련 프로그램을 개발하고 있습니다. 사실 매일 하던 것만 개발하다 보니 지루하기도 하고, 개발의 방향성이 너무 폭이 좁은 느낌이 들었습니다. 그러다 블로그 포스팅 및 취미로 이것저것 개발하다 보니, 최근에는 Open API까지 건드리게 됐습니다.

예전에도 Open API 라든가 REST API라는 단어를 들어보긴 했지만, 사용해볼 기회도 없고 어떻게 해야 하는지도 몰랐습니다. 그런데 막상 도전해보니 큰 어려움이 없더군요. 오히려 가이드대로 사용하면 막히는 것 없이 바로 동작하는 것 같습니다.

이번 포스팅은 저처럼 처음 Open API를 다루는 분들에게 좋은 가이드가 되길 바라면서 작성했습니다. 본문의 예제 프로젝트는 Open API를 활용하여 고속도로 교통예보 현황 정보를 얻는 방법을 소개합니다.

REST, REST API, Open API?

Open API를 다뤄보면서 자주 접했던 단어가 RESTful 및 REST API 였습니다. 인터넷에 검색해보면, 같은 의미라는 글도 있고 결국 데이터를 주고 받는 형식이라고 하더군요.

위키피디아에는 REST를 다음과 같이 정의하고 있습니다.

REST(Representational State Transfer)는 WWW(World Wide Web)과 같은 분산 하이퍼미디어 시스템을 위한 소프트웨어 아키텍처의 한 형식입니다.

즉, 어떠한 자원(문서, 데이터 등)을 이름으로 구분하여 정보를 주고 받는 것을 의미합니다. 그리고 주고받는 데이터는 일반적으로 JSON 또는 XML 형식을 많이 사용합니다.

작년에 코로나 때문에 마스크 품귀 현상이 일어났을 때, 약국마다 마스크 보유 수량이 얼마나 있는지 Open API로 제공했었는데요. 이렇게 국가에서 보유하고 있는 다양한 데이터를 개방하여 국민들이 쉽게 접근할 수 있는 것이 Open API입니다. 물론 기업에서 제공하기도 합니다.

따라 하기

우선, 한국 도로공사에서 제공하는 고속도로 공공데이터 포털 사이트를 접속합니다.

링크: data.ex.co.kr/openapi/basicinfo/openApiInfoM?apiId=0303&serviceType=OPENAPI&keyWord=&searchDayFrom=2014.12.01&searchDayTo=2019.10.21&CATEGORY=&GROUP_TR=

고속도로 공공데이터 포털

여기서 눈여겨볼 정보는 다음과 같습니다. HTTP GET과 HTTP POST로 호출할 수 있고, 검색 결과는 XML 또는 JSON입니다.

항목명	값
Request URL	http://data.ex.co.kr/openapi/safeDriving/forecast
호출 방법	HTTP GET, HTTP POST
검색 결과 포맷	XML, JSON

그리고 요청 변수는 key와 type 두 개의 string이 필요합니다.

요청 변수	값	조건	설명
key	string	필수	발급받은 인증키
type	string	필수	검색 결과 포맷

페이지의 하단에는 예제 실행하기 버튼이 있습니다.

예제 실행하기 버튼

key가 값이 test이면 말 그대로 테스트 용입니다. 나중에 실제 서비스를 운영한다면 인증키 발급을 요청하고, 그 키로 입력해야 합니다. type은 xml 또는 json 편한 것으로 선택하면 됩니다. 선택된 항목에 따라 URL이 생성되고, 이 URL에 데이터를 요청하면 최하단의 데이터가 회신됩니다.

key와 type에 따른 URL 및 결과

이제 C# 프로젝트를 생성해 보겠습니다. 아주 간단히 확인하기 위해 C# Console로 만들겠습니다.

C# 콘솔 앱 프로젝트 생성

프로젝트 생성 후 도구 > NuGet 패키지 관리자 > 솔루션용 NuGet 패키지 관리... 메뉴를 클릭합니다. 그리고 Newtonsoft.Json을 설치합니다.

NuGet 패키지 Newtonsoft.Json 설치

그리고 아래의 namespace를 추가합니다.

using System.Diagnostics;
using System.IO;
using Newtonsoft.Json.Linq;
using System.Net;
using System.Net.Http;

데이터를 요청할 requestURL은 인증키가 test이고, 타입은 json입니다.

static string requestURL = "http://data.ex.co.kr/openapi/safeDriving/forecast?key=test&type=json";        

해당 주소에 json 타입의 GET method를 호출하여 데이터를 받습니다.

WebRequest request = WebRequest.Create(requestURL);
request.Method = "GET";
request.ContentType = "application/json";

using (WebResponse response = request.GetResponse())
using (Stream stream = response.GetResponseStream())
using (StreamReader reader = new StreamReader(stream))
{
	string data = reader.ReadToEnd();
	//...
}                

마지막으로 json 타입의 응답 결과를 파싱하여 원하는 정보를 출력합니다.

string data = reader.ReadToEnd();
var obj = JObject.Parse(data);
var list = obj["list"];

Console.WriteLine("============ List ============");
Console.WriteLine(obj);

Console.WriteLine("============ Item ============");
foreach (var item in list)
{
	Console.WriteLine(string.Format("{0}: {1}", "날짜", item["sdate"]));
	Console.WriteLine(string.Format("{0}: {1}", "시간", item["stime"]));
	Console.WriteLine(string.Format("{0}: {1}", "전국 교통량", item["cjunkook"]));
	Console.WriteLine(string.Format("{0}: {1}", "지방 방향 교통량", item["cjibangDir"]));
	Console.WriteLine(string.Format("{0}: {1}", "서울 방향 교통량", item["cseoulDir"]));
	Console.WriteLine(string.Format("{0}: {1}", "서울->대전 소요시간", item["csudj"]));
	Console.WriteLine(string.Format("{0}: {1}", "서울->대구 소요시간", item["csudg"]));
	Console.WriteLine(string.Format("{0}: {1}", "서울->울산 소요시간", item["csuus"]));
	Console.WriteLine(string.Format("{0}: {1}", "서울->부산 소요시간", item["csubs"]));
}

item["..."]에는 아래의 출력 변수 이름을 입력합니다.

데이터 출력 결과 형식

아주 간단하죠? 예제 코드도 첨부했습니다.

ExamOpenAPI.zip

4.92MB