[Network] REST API

* REST API
* REST 성숙도 모델
* Open API와 API Key

REST API는 웹에서 사용되는 데이터나 자원(Resource)을 HTTP URI로 표현하고,
HTTP 프로토콜을 통해 요청과 응답을 정의하는 방식이다.

간단하게 파일을 전송하려면 FTP라는 길이 있어야 한다. (File Transfer Protocol) / HTTP 또한 마찬가지

웹 애플리케이션에서는 HTTP 메서드를 이용해 서버와 통신한다. 예를 들면

GET을 통해 웹 페이지나 데이터를 요청하고,
POST로 새로운 글이나 데이터를 전송하고,
DELETE로 저장된 글이나 데이터를 삭제할 수 있다.

객체형태 데이터를 보내면 서버에서 만들어진 함수(API)가 실행(전달인자로 데이터가 들어옴) -> 데이터베이스에 저장-> 성공했어! 응답

이처럼 클라이언트와 서버가 HTTP 통신을 할 때는 어떤 요청을 보내고 받느냐에 따라 메서드의 사용이 달라진다.

이런 사용은 아무런 규칙 없이 이루어지는 것이 아니다. 만약 혼자서 웹사이트를 만들고 관리한다면, API를 어떻게 설계하고 구현하든 상관이 없다. 그러나 일반적인 회사에서 진행하는 서비스 개발은 대부분 팀 단위로 진행한다. 그렇기에 사소한 것 하나라도 규칙(rule)이 있어야 소통이 원활하다.

REST API

어떻게 요청과 응답을 하는 것이 바람직한 방법일까?

만약 어떤 식당이나 카페에서 식사 혹은 음료를 주문한다고 가정했을 때, 메뉴판의 상태가 아래 사진과 같다면 알아보기도 어렵고, 주문하기도 어려울 것이다.

클라이언트와 서버 사이에도 데이터와 리소스를 요청하고, 요청에 따른 응답을 전달하기 위한 메뉴판이 필요하다.
이 메뉴판을 보고 클라이언트는 식당에서 식사를 주문하듯 서버에 요청하고, 이에 대한 응답을 메뉴판에 있는 사진이나 음식에 대한 설명처럼 다시 서버에서 클라이언트로 전송하게 된다.
따라서 HTTP 프로토콜을 기반으로 요청과 응답에 따라 리소스를 주고받기 위해서는 알아보기 쉽고 잘 작성된 메뉴판이 필요하다!!!
이 역할을 API가 수행해야 하므로 모두가 잘 알아볼 수 있도록 작성하는 것이 중요하다.

HTTP 통신에서도 요청과 응답을 할 때, '제대로 보내고 받을 수 있는' 일종의 규약이 존재한다.

API의 대표적인 아키텍처, REST API

REST API에서 REST는 “Representational State Transfer”의 약자이다. (직역 : 상태를 묘사한 전송)

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

그렇다면 어떻게 해야 적절한 REST API를 디자인할 수 있을까?

REST API를 디자인하는 방법

REST API를 작성할 때는 몇 가지 지켜야 할 규칙들이 있다. 로이 필딩이 논문에서 제시한 REST 방법론을 보다 더 실용적으로 적용하기 위해 레오나르드 리차드슨(Leonard Richardson)은 REST API를 잘 적용하기 위한 4단계 모델을 만들었다.

리차드슨의 REST 성숙도 모델을 구조화하면 다음과 같다.
REST 성숙도 모델은 총 4단계(0~3단계)로 나누어진다.

앞서 이야기한 로이 필딩은 이 모델의 모든 단계를 충족해야 REST API라고 부를 수 있다고 주장했다. 그러나 실제로 엄밀하게 3단계까지 지키기 어렵기 때문에 2단계까지만 적용해도 좋은 API 디자인이라고 볼 수 있고, 이런 경우를 HTTP API 라고도 부른다.

REST 성숙도 모델 - 0단계

REST 성숙도 모델에 따르면, 0단계에서는 단순히 HTTP 프로토콜을 사용하기만 해도 된다.
물론 이 경우, 해당 API를 REST API라고 할 수는 없으며, 0단계는 REST API를 작성하기 위한 기본 단계이다.

허준이라는 이름의 주치의의 예약 가능한 시간을 확인하고, 어떤 특정 시간에 예약하는 상황을 예로 들어 보면,

예시에서는 HTTP 프로토콜을 사용하고 있는 것을 확인할 수 있다.
이렇듯 단순히 HTTP 프로토콜을 사용하는 것이 REST API의 출발점이다.

REST 성숙도 모델 - 1단계

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

Endpoint란?

We could do it simpler, by examples:
/this-is-an-endpoint
/another/endpoint
/some/other/endpoint
/login
/accounts
/cart/items
and when put under a domain, it would look like:
https://example.com/this-is-an-endpoint
https://example.com/another/endpoint
https://example.com/some/other/endpoint
https://example.com/login
https://example.com/accounts
https://example.com/cart/items
Can be either http or https, we use https in the example.
Also endpoint can be different for different HTTP methods, like
GET /item/{id}
PUT /item/{id}
would be two different endpoints - one for retrieving (as in "cRud" abbreviation), and the other for updating (as in "crUd")

an endpoint is simply one end of a communication channel.

앞서 0단계에서는 요청에서의 엔드포인트로 모두 /appointment를 사용하였다.

하지만 1단계에서는 요청하는 리소스가 무엇인지에 따라 각기 다른 엔드포인트로 구분하여 사용한다.
아래의 예시에서 예약 가능한 시간 확인이라는 요청의 응답으로 받게 되는 자원(리소스)은 허준이라는 의사의 예약 가능한 시간대이다.
그렇기 때문에 요청 시 /doctors/허준이라는 엔드포인트를 사용한 것을 볼 수 있다.
그뿐만 아니라, 특정 시간에 예약하게 되면, 실제 slots라는 리소스의 123이라는 id를 가진 리소스가 변경되기 때문에, 하단의 특정 시간에 예약이라는 요청에서는 /slots/123으로 실제 변경되는 리소스를 엔드포인트로 사용하였다.

예시와 같이, 어떤 응답이 제공되는지 혹은 어떤 리소스를 변화시키는지에 따라 각기 다른 엔드포인트를 사용하기 때문에, 적절한 엔드포인트를 작성하는 것이 중요하다.

엔드포인트 작성 시에는 동사, HTTP 메서드, 혹은 어떤 행위에 대한 단어 사용은 지양하고,
리소스에 집중해 명사 형태의 단어로 작성하는 것이 바람직하다.
(예: 엔드포인트에는 리소스를 지칭하는 명사 사용이 권장되며, 엔드포인트 inquiry 등은 명사이긴 하나 행위에 대한 명사형이기 때문에 권장되지 않음)

더불어 요청에 따른 응답으로 리소스를 전달할 때에도

사용한 리소스에 대한 정보와 함께 리소스 사용에 대한 성공/실패 여부를 반환해야한다.
예를 들어, 김코딩 환자가 허준 의사에게 9시에 예약을 진행하였으나 해당 시간이 마감되어 예약이 불가능하다고 가정할 때, 아래와 같이 리소스 사용에 대한 실패 여부를 포함한 응답을 받아야 한다.

REST 성숙도 모델 - 2단계

REST 성숙도 모델 2단계에서는 CRUD에 맞게 적절한 HTTP 메서드를 사용하는 것에 중점을 둔다.
앞서 0단계와 1단계 예시에서는 모든 요청을 CRUD(Create, Read, Update, Delete)와 상관없이 POST 메서드를 사용하고 있다.
그러나 REST 성숙도 모델 2단계에 따르면, 이는 CRUD에 따른 적합한 메서드를 사용한 것이 아니다.

먼저 예약 가능한 시간을 확인한다는 것은 예약 가능한 시간을 조회(READ)하는 행위를 의미하고,

그렇기 때문에 GET 메서드를 사용하여 요청을 보내야 한다.
이때 GET 메서드는 body를 가지지 않기 때문에 query parameter를 사용하여 필요한 리소스를 전달한다.

특정 시간에 예약한다는 것은 해당 특정 시간에 예약을 생성(CREATE)한다는 것과 같다.

예약을 생성(CREATE)하기 위해서는 POST 메서드를 사용하여 요청을 보내야 하며,
POST 요청에 대한 응답이 어떻게 반환되는지가 중요하다.
이 경우 응답은 새롭게 생성된 리소스를 보내주기 때문에, 응답 코드는 201 Created 로 명확하게 작성해야 하며,
관련 리소스를 클라이언트가 Location 헤더에 작성된 URI를 통해 확인할 수 있도록 하면
완벽하게 REST 성숙도 모델의 2단계를 충족한 것이라고 볼 수 있다.

HTTP 메서드를 사용할 때 몇가지 규칙에도 유의해야 한다.

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

API를 작성할 때, REST 성숙도 모델의 2단계까지 적용하면 대체적으로 잘 작성된 API라고 한다. 물론 로이 필딩은 앞서 이야기한 바와 같이 3단계까지 만족하지 못한 API는 REST API가 아닌 HTTP API라고 불러야 한다고 주장하지만, 몇 모범적인 API 디자인조차도 REST 성숙도 모델의 3단계까지 적용한 경우는 드물다. 따라서 3단계까지 무조건적으로 모두 적용해야 하는 것은 아니다.

REST 성숙도 모델 - 3단계

마지막 단계는 HATEOAS(Hypermedia As The Engine Of Application State)라는 약어로 표현되는 하이퍼미디어 컨트롤을 적용한다.

인터넷 초기엔 하이퍼"텍스트" 위주의 데이터였지만 웹이 발달하면서 이미지, 동영상 등 다양한 미디어를 전송할 수 있게되면서 하이퍼텍스트를 포함하는 하이퍼"미디어"라는 개념으로 확장되었다. (결국은 두 단어가 비슷한 의미로 혼용되어 사용)

3단계의 요청은 2단계와 동일하지만, 응답에는 리소스의 URI를 포함한 링크 요소를 삽입하여 작성해야 한다.
HATEOAS(Hypertext As The Engine Of Application State) 원칙을 준수했다고도 하며, 응답 내에 새로운 링크를 넣어 새로운 기능에 접근할 수 있도록 하는 것이 핵심이다.
이때 응답에 들어가게 되는 링크 요소는 응답을 받은 다음에 할 수 있는 다양한 액션들을 위해 많은 하이퍼미디어 컨트롤을 포함한다.
아래와 같이 허준이라는 의사의 예약 가능 시간을 확인한 후에는 그 시간대에 예약을 할 수 있는 링크를 삽입하거나, 특정 시간에 예약을 완료하고 나서는 그 예약을 다시 확인할 수 있도록 링크를 작성해 넣을 수도 있다.
만약 클라이언트 개발자들이 응답에 담겨 있는 링크들을 눈여겨본다면, 이러한 링크들은 조금 더 쉽고, 효율적으로 리소스와 기능에 접근할 수 있게 하는 요소가 될 수 있다.

endpoint 작성의 예

상황 1)
트위터와 비슷한 웹사이트를 개발하는 중, 데이터베이스에 게시물이 너무 많으므로 글 목록을 보여주기 위해 무한 스크롤을 이용해 추가적으로 게시글들을 불러오려고 한다.

- 이때 추가적인 트윗을 불러오기 작성해야 할 엔드포인트(endpoint)로 HTTP 메서드는 GET이 적합하며,
- 엔드포인트는 응답을 통해 받게 되는 리소스가 무엇인지를 알려주는 명확한 명사 형태로 작성하는 것이 적절하다.

GET /tweets?offset=10&limit=10

** 결과적으로 응답으로 제공되는 리소스가 트윗이므로, 이 경우에는 트윗 목록을 조회하기 위해 처음에 사용했던 엔드포인트 (GET /tweets) 를 재사용하는 편이 적절하다.

** 수십, 수백개의 트윗을 한꺼번에 응답으로 받기에는 상당한 양의 payload가 전달되므로, 페이지네이션(pagination)을 이용해 트윗 목록을 끊어주는 게 좋다. 예를 들어, 총 120개의 트윗 중 인덱스가 10~20인 트윗, 즉 열 개의 트윗만 가져온다고 가정했을 때, 보통 이 때 관습적으로 사용되는 Query Parameter는 offset, limit으로 이 경우 offset=10&limit=10 으로 해당 트윗을 가져올 수 있다.

상황2)
위치 기반 맛집 탐색 앱의 기획을 전달받아 특정 위치 기반의 모든 식당 목록을 조회하고, 그중 한식만 필터링하는 기능이 추가해야 한다.

- 리소스 요구사항은 식당 목록이므로, 엔드포인트만 보고도 식당 목록이 응답으로 전달될 것을 예상할 수 있도록 이름을 짓는 것이 좋다. 따라서, 엔드포인트에는 resturants 와 같이 리소스를 지칭하는 단어가 포함되어 있어야 한다.
- 추가적으로 필터링을 위해서 해당 리소스의 필터링 조건을 Query Parameter로 전달하는 것이 바람직하며, 여기에는 한식임을 나타낼 만한 type=korean 을 추가하였다.

GET /restaurants?coordinate=126.9178889,37.5561619&type=korean

** 위치 기반의 식당이므로 특정 반경의 중심이 될 만한 좌표(coordinate)를 Query Parameter로 제공했으며, 이 역시도 필터링의 한 방법으로 볼 수 있다.

게시판에서 10번 게시물을 삭제하는 엔드포인트를 작성하기 위해서는 DELETE 메서드를 사용하는 것이 적절하다.

DELETE /articles/10

엔드포인트에서 어떤 리소스를 삭제하는지 명시하는 것이 적절하며, 앞에 DELETE 메서드가 있는데 엔드포인트에 또 delete를 사용할 필요는 없다.

요청과 응답의 예

상황1)

아래는 유저가 영화를 보기 위해 좌석을 예매하기 위한 요청과 응답이다.

요청
POST /seats/g10 HTTP/1.1
[헤더 생략]
{ "user": "kimcoding" }


정상 응답
HTTP/1.1 201 created
[헤더 생략]
{ 
	"message": "예약이 성공적으로 진행되었습니다",
	"seat" : "g10",
	"user" : "kimcoding"
}


오류 응답
HTTP/1.1 409 Conflict
[헤더 생략]
{ 
  "message": "예약에 실패했습니다",
  "seat" : "g10",
  "status": "다른 사용자에 의해 예약됨"
 }

상황2)

도서 검색 사이트에서 도서 제목을 바탕으로 검색 기능을 구현하려고 한다.

요청이 REST 원칙에 적합하도록 하려면 GET 요청에는 Query Parameter를 사용해야 한다.
- 도서 제목을 바탕으로 검색하는 기능을 구현한다는 것은 GET 요청을 사용하여 데이터를 조회하는 것을 의미한다.
- 그러나 GET 요청의 경우 body가 존재하지 않기 때문에 이를 Query Parameter를 이용하여 구현해야 한다.

아래는 도서 검색 사이트에서 도서 제목을 검색하기 위한 요청과 응답이다.

요청
GET /books?title=code
[헤더 생략]

// GET 요청은 body가 없으므로 아래는 잘못된 예시!!!!! 
{ "query": { "title": "code" } } // 잘못된 예시!!!! 


정상 응답
HTTP/1.1 200 OK
[헤더 생략]
{
	"books": [
		{ "isbn": "9780132350884", "title": "Clean Code", "author": "Robert C.Martin", "price": "$42.47" },
        { "isbn": "0735619670", "title": "Code Complete", "author": "Steve McConnell", "price": "$24.17" }
	]
}

728x90

저작자표시

'FE > Network' 카테고리의 다른 글

[Network] Postman으로 HTTP 요청 및 응답 받아오기 (0)	2023.03.30
[Network] Open API란? (0)	2023.03.30
[Network] AJAX, SSR, CSR (0)	2023.03.28
[Network] HTTP (0)	2023.03.28
[Network] URL과 URI, IP와 포트, 도메인과 DNS (0)	2023.03.28

개발해도유