• HTTP는 HyperText Transfer Protocol의 줄임말로, HTML과 같은 문서를 전송하기 위한 Application Layer 프로토콜이다.
• HTTP는 웹 브라우저와 웹 서버의 소통을 위해 디자인되었다.

Lab_01_HTTP Messages

HTTP messages

HTTP messages는 클라이언트와 서버 사이에서 데이터가 교환되는 방식이다. HTTP messages에는 다음과 같은 두 가지 유형이 있다.

• 요청(Requests)
• 응답(Response)

HTTP messages는 몇 줄의 텍스트 정보로 구성된다. (구성파일, API ,기타 인터페이스에서 HTTP messages를 자동 완성한다.)

[그림] HTTP messages의 구조

1. start line : start lined에는 요청이나 응답의 상태를 나타낸다. 응답에서는 status line이라고 부른다.
2. HTTP headers : 요청을 지정하거나, 메시지에 포함된 본문을 설명하는 헤더의 집합
3. empty line : 헤더와 본문을 구분하느 빈 줄이 있다.
4. body : 요청과 관련된 데이터나 응답과 관련된 데이터 또는 문서를 포함

start line, HTTP headers를 묶어 요청이나 응답의 헤더라고 하고, payload는 body라고 이야기한다.

Start line

• 수행할 작업(GET,PUT,POST 등)이나 방식(HEAD or OPTIONS)을 설명하는 HTTP method를 나타낸다.
• 요청 대상 또는 프로토콜 , 포트, 도메인의 절대 경로는 요청 컨텍스트에 작성된다. 이 요청 형식은 HTTP method 마다 다르다.
• HTTP 버전에 따라 HTTP messages 의 구조가 달라진다. 따라서 start line 에 HTTP 버전을 함께 입력

Headers

• 요청의 Headers는 기본 구조를 따른다. 헤더 이름(대소문자 구분이 없는 문자열), 콜론(:), 값을 입력한다. 값은 헤더에 따라 다르다. 여러 종류의 헤더가 있고, 다음과 같이 그룹을 나눌 수 있다.
  

• General headers : 메세지 전체에 적용되는 헤더로, body를 통해 전송되는 데이터와는 관련이 없는 헤더
• Request headers : fetch를 통해 가져올 리소스나 클라이언트 자체에 대한 자세한 정보를 포함하는 헤더
• Reprsentation headers : 이전에는 Entity hearders로 불렀으며, body에 담긴 리소스의 정보를 포함하는 헤더

Body

요청의 본문은 HTTP messages 구조의 마지막에 위치한다. 모든 요청에 body가 필요하지는 않다. 예를 들어 GET , HEAD,DELETE,OPTIONS 처럼 서버에 리소스를 요청하는 경우에는 본문이 필요하지 않다. body는 다음과 같이 두 종류로 나눌 수 있다.

• Single-resource bodies(단일 리소스 본문) : 헤더 두개로 정의된 단일 파일로 구성
• Multiple-resource bodies(다중 리소스 본문) : 여러 파트로 구성된 본문에서는 각 파트마다 다른 정보를 지님

Status line

앞서 응답의 start line은 status line이라고 언급했었다. 따라서 응답의 첫 줄은 Status line이라고 부르며 다음의 정보를 포함한다.
1. 현재 프로토콜의 버전(HTTP/1.1)
2. 상태 코드 - 요청의 결과를 나타냄 (200,302 등)
3. 상태 텍스트 - 상태 코드에 대한 설명

Lab_02_HTTP API

애플리케이션(응용프로그램)에서 사용할 수 있도록, 운영체제나 프로그래밍 언어가 제공하는 기능을 제어할 수 있게 만든 인터페이스를 뜻한다. 즉, 애플리케이션이 어떤 프로그램이 제공하는 기능을 사용할 수 있게 만든 매개체이다.
컴퓨터와 인간을 연결시키는 UI와 반대로, API는 컴퓨터나 소프트웨어를 서로 연결한다.

날씨 정보 앱을 만들려면, 기상청(서버)이 제공하는 API에 원하는 날씨 정보를 요청해 데이터를 받은 다음 UI 형태로 사용자에게 날씨 정보를 제공할 수 있다. 더 자세히는 기상청이 DB서버에 날씨 정보를 보관해놓고, 다른 응용 프로그램들이 DB서버에서 날씨 데이터를 조회하고 조작할 수 있도록 API를 미리 개발해놓는다.

HTTP API

HTTP를 사용하여 프로그램끼리 소통하는 API를 말한다. 보통 우리가 흔히 보는 OPEN API,facebook API,kakao API 등의 대부분 API는 HTTP라는 통신 규칙으로 소통하는 API이다.

REST API

• REST APID에서 REST는 "Representational State Transfer" 의 약자로, 로이 필딩의 박사 학위 논문에서 웹의 장점을 최대한 활용할 수 있는 아키텍처로써 처음 소개되었다.
• REST API는 웹에서 사용되는 데이터나 자원을 HTTP URI로 표현하고, HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식을 말한다.

예를 들어, 식당에서 메뉴판을 보고 주문을 하려고 할 때,
메뉴판이 다음과 같다고 하면, 메뉴 주문이 힘들어질 수 있다.
클라이언트와 서버 사이에도 데이터와 리소스를 요청하고 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다. HTTP 프로토콜 기반으로 요청과 응답에 다라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요한데, 이 역할을 API가 수행해야 한다.

Good case : REST API

REST API를 작성할 때는 지켜야할 4가지 규칙이 제시된다.

리차드슨의 REST 성숙도 모델을 구조화 하면 다음과 같다.
로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했으며, 실제로 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있다. 이런 경우엔 HTTP API라고도 부른다.

REST 성숙도 모델 - 0단계

0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다. 이 경우에는 REST API라고 볼 수 없으며, 0단계는 좋은 REST API를 작성하기 위한 기본단계이다.
단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.

[그림] 0단계 REST API 작성 예시

REST 성숙도 모델 - 1단계

REST 성숙도 모델에 따르면, 1단계에서는 개별 리소스와의 통신을 준수해야 한다. REST API는 웹에서 사용도는 데이터나 자원을 HTTP URI로 표현되어 모든 자원은 개별 리소스에 맞는 엔드포인트를 사용해야 한다는 것과 요청하고 받은 자원에 대한 정보를 응답으로 전달해야 한다는 것이 1단계에서 의미하는 바이다.

엔드포인트 : API(응용 프로그램 프로그래밍 인터페이스)는 하나의 응용 프로그램이 다른 응용 프로그램에 서비스를 요청하는 방식입니다. 개발자는 API를 통해 이미 존재하는 응용 프로그램 기능을 다시 빌드하지 않아도 됩니다. API 엔드포인트는 이러한 요청(API 호출)이 수행되는 곳입니다.

[그림] 1단계를 적용시킨 REST API 작성 예시

앞서 0단계에서는 모든 요청에서 엔드포인트로 /appointment 를 사용했다. 위 그림은 1단계 규칙인 서로 다른 엔드포인트를 사용해 API를 작성한 예시이다. 서로 다른 요청 내용에 각각의 다른 엔드포인트를 지정했다. 즉, 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하였다.

엔드포인트 작성 시에는 동사,HTTP메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고, 리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직한 방법이다.

성숙도 모델 - 2단계

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.

CRUD는 대부분의 컴퓨터 소프트웨어가 가지는 기본적인 데이터 처리 기능인 Create(생성), Read(읽기), Update(갱신), Delete(삭제)를 묶어서 일컫는 말이다. 사용자 인터페이스가 갖추어야 할 기능(정보의 참조/검색/갱신)을 가리키는 용어로서도 사용된다.

앞서 0단계와 1단계 예시에서 보았듯, 모든 요청을 CRUD에 상관없이 POST로 하고 있다. 그러나 REST 성숙도 모델 2단계 따르면 이는 CRUD에 따른 적합한. 메서드를 사용한 것은 아니다.

• 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ)하는 행위를 의미
• 특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)한다는 것과 같다.

따라서, 조회(READ) 동작을 위해서는 GET 메서드를 사용하고, 생성(CREATE) 동작을 위해서는 POST 메서드를 사용한다. 그리고, 2단계에서는 POST 요청에 대한 응답이 어떻게 반환되는지도 중요하다.

이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드도 201 Created 로 명확하게 작성해야 하며, 관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 해야, 완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

메서드를 사용할 때도 규칙이 존재한다.

• GET 메서드는 서버의 데이터를 변화시키지 않는 요청에 사용해야 한다.
• POST 는 요청마다 새로운 리소스를 생성하고 PUT은 요청마다 리소스를 반환한다. 이렇게 매 요청마다 같은 리소스를 반환하는 특징을 멱등(idempotent)하다고 한다. 멱등성을 가지는 메서드 PUT과 그렇지 않은 POST는 구분하여 사용해야 한다.
• PUT과 PATCH 도 구분하여 사용해야 한다. PUT은 교체, PATCH는 수정의 용도로 사용해야 한다.

REST 성숙도 모델 - 3단계

마지막 단계는 HATEOAS(Hypertext As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다. 3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성한다는 것이 다르다.

예를 들어 위와 같이 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다. 이렇게 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 3단계의 중요 포인트이다.

요약 정리

• 0단계 - HTTP 사용
• 1단계 - 개별 리소스 중심의 엔드포인트 작성
• 2단계 - CRUD에 맞는 적절한 메서드 사용
• 3단계 - 확장성을 위한 하이퍼미디어 컨트롤 적용

HTTP API 테스트 도구

• CLI : curl , wuzz
• GUI : Postman,Insomnia

Reference

HTTP API