PMB 12 W7D3 공공데이터 오픈 API 기능과 구조 살펴보기

PMB 부트캠프 12기/데일리과제

PMB 12 W7D3 공공데이터 오픈 API 기능과 구조 살펴보기

clap.jin 2022. 6. 24. 16:47

API ( Application Programming Interface) : '애플리케이션'을 ‘프로그래밍’ 하는데 필요한 ‘인터페이스’

API는 서버와 클라이언트가 서로 정보를 어떻게 주고받을지에 대해 미리 정의한 규칙으로 통신할 때 기반이 되는 역할을 한다.

예를 들어 은행 창구의 직원은 고객의 돈을 은행에 넣고 빼는 과정을 돕기 위해 고객과 은행의 경계에서 해당 업무를 처리하는 역할을 하는 것과 유사하다

< 은행창구 직원 역할 >

< API 역할>

Open API : '누구나 쓸 수 있는 공개된 API'를 뜻한다

잘 설계한 API를 오픈해 제공하는 이유는 자사의 서비스 기능을 다양한 서비스에서 활용할 수 있도록 해 서비스의 저변을 넓히는 목적이 있다. 메타 서비스를 제공하는 대기업들의 시장 확대를 목적으로 오픈 API를 운영하거나 공공의 목적으로 비영리기관에서 무료로 API를 제공하는 경우도 있다.

RESTful API

일정한 아키텍처의 제약 조건을 준수하는 애플리케이션 프로그래밍 인터페이스를 만들어 사용하기로 하였는데 그 중 대표적인 방식이 RESTful API

RESTful API의 명령 종류

Create(생성) : POST
Read(읽어오기) : GET
Update(변경) : PUT(전체)/PATCH(일부)
Delete(삭제) : DELETE

Open API 기능과 구조 파악하기

Open API를 살펴보기 위해 공공데이터포털에서 '한국공항공사_항공기 운항정보'에 대한 자료이며 한국공항공사에서 제공하는 국제선 운항 스케줄의 정보를 얻을 수 있다.

1) API 기본정보

2) 요청변수

3) 출력 결과

Open API 입출력 구조 살펴보기

기능 하나를 선정해 API의 역할, 입출력 구조를 정리해 봅니다.

OPEN API를 입출력 구조를 살펴보기 위해 개발자들이 많이 쓴다는 포스트맨 API 플랫폼을 이용해 보았다.

처음 API를 이용해 본 비개발자인 나도 쉽게 사용할 수 있을만큼 잘 되어있다.

포스트맨 다운로드 URL: https://en.wikipedia.org/wiki/Postman_(software)

포스트맨 설명: API를 설계, 빌드, 테스트 및 반복할 수 있는 API 플랫폼이다.

1) 요청변수 설정

2022년 6월 25일 김포공항 출발해서 제주공항으로 도착하는 제주항공 7C 147 편 항공편의 정보를 설정해보았다.

(1) GET 설정 :가장 맨 위 RESTful API의 READ 읽어오기 GET 으로 명령 ( Open API는 GET 으로만 가능하다)

(2) 주소 입력: 지정된 사이트 값을 복사하여 붙여 넣는다.

(3) Params 입력 : KEY VALUE 값은 전부 입력한다. ( 한 가지라도 누락시 에러가 뜬다.)

( 요청변수를 설정하고 출력결과를 확인하는 과정에서 계속해서 에러가 났고, 여러번 입력값을 바꿔서 요청한 끝에 OPEN API 문제점을 발견하게 되었다. 출발도시와 도착도시가 잘못 설계되어있어, 출발 도시 코드를 도착도시 KEY 값에, 도착 도시 코드를 출발도시 KEY 값에 입력해야 올바른 정보가 나온다. ~~API 가 잘못설정되어있다고 어디다 말해야하는거지...~~ 우선 과제도 잘못 설계된거에 맞춰서 출발-도착도시를 바꾸어서 진행하였다.)

2) 요청변수 출력 결과 확인