빰_s

(25.01.13) API 본문

Java/Spring

(25.01.13) API

Job_E 2025. 1. 13. 00:45

우리가 웹 개발을 할 때를 넘어 인터넷을 사용할 때 우리도 모르게 항상 접하게 되는

Application Programming Interface : 한 프로그램에서 다른 프로그램으로 데이터를 주고받기 위한 방법(코드)

2가지 예시를 들어보며 API를 알아보자.

예시1. 식당 주문

우리(Client)가 식당을 갔을 때,

그 식당의 메뉴판(API List)을 보고 주문(Method)을 하면,

주방(Server)에서 주문을 받아 음식을 제공해준다.

이게 우리가 웹 개발을 할때 많이 사용하는 API의 원리라고 할 수 있다.

 

이번엔 웹 사이트를 기반으로 예시를 한번 더 들어보겠다.

예시 2. 웹툰 조회

우리(Client)가 네이버 웹툰 사이트에서

이 사이트의 웹툰 목록(API List)를 보고 특정 웹툰을 보여달라 요청(Method)하면,

웹툰 사이트(Server)에선 해당 웹툰을 보여준다.

 

식당 주문이나 웹툰 조회나 같은 맥락으로 파악할 수 있듯, 이게 우리가 일상에서 또는 개발 과정에서 API를 접하거나 만들어사 사용 및 작동되는 사이클이라 볼 수 있다.

(※ API의 예시)

- (GET 요청) comic.naver.com/webtoon/detail?titleId=641253

한창 연재되고 있는 네이버 웹툰 '외모지상주의'의 무료로 풀린 최신화를 보여준다.

- (GET 요청)  comic.naver.com/webtoon/detail?titleId=318995

현재 완결된 네이버 웹툰 '갓 오브 하이스쿨'의 무료로 풀린 최신화를 보여준다.

 

여기서 이 (GET 요청) comic.naver.com/webtoon/detail?titleId=318995가 가지는 요소는 3가지로 분류될 수 있다.

(GET 요청) >>> 1. Method

comic.naver.com/webtoon/detail >>> 2. EndPoint

titleId=318995 >>> 3. Parameter

1. 요청 방식(Method)(※ GET, POST, PUT, DELETE)

어떤 방식으로 데이터를 조작할지 정의하기 위해 쓰인다.

 

2. 요청 자료(EndPoint)

어떤 데이터를 요청할지 정하기 위해 필요한 구성요소로써, 뒤에 달리는 파라미터에 따라 제공되는 정보가 달라진다.

 

3. 파라미터(Parameter)

엔드포인트와 함께 API 요청을 보내기 위해 삽입되는 정보를 의미한다.

위의 두 요소에서 볼 수 있듯, 엔드포안트 앞에 titleId의 값이 '641253'이냐, ' 318995'이냐에 따라 외모지상주의를 보여줄지, 갓 오브 하이스쿨을 보여줄지 다르게 된다.

Comments