나만의 무기를 갖기 : API 설계

5주간의 짧은 기간 동안 진행해야 하는 프로젝트이고, 아직 현업 개발자도 아니기에 개발 프로젝트에서 진행해야 하는 구체적인 작업들을

명확히 이해하지 못하는 것이 사실이다. 그럼에도 불구하고 몇 가지 시도를 해보기로 팀원들과 약속하였고, API 설계 역시 그중 하나였다.

팀장으로서 우리 프로젝트를 조금이라도(?) RESTful 하게 만들기 위해, API 설계의 개념과 Rest Architecture가 무엇인지 정리해보았다.

그리고 정리 과정에서 우리 프로젝트에 적용할 기준 두 가지를선정해보았다.

API 설계란?

서비스에서 어떤 리퀘스트를 보냈을 때, 무슨 리스폰스를 받는지는 많은 경우 그 서비스를 만드는 개발자들이 정한다고 한다.

하나의 서비스를 만들 때 프론트엔드 개발자들과 백엔드 개발자들은 '프론트엔드에서 이 URL로 이렇게 생긴 리퀘스트를 보내면,

백엔드에서 이런 처리를 하고 이런 리스폰스를 보내주는 것으로 정합시다'와 같은 논의를 하고 관련 내용을 정리하는데,

이것을 'API 설계'라고 한다.

Web API란?

API란 Application Programming Interface의 약자로, 웹 개발에서는 어느 URL로 어떤 리퀘스트를 보냈을 때, 무슨 처리가 수행되고

어떤 리스폰스가 오는지에 관해 미리 정한 규격을 Web API라고 한다. Web API를 설계한다는 것은 서비스에서 사용될 모든 URL들을

나열하고, 각각의 URL에 관한 예상 리퀘스트와 리스폰스의 내용을 정리한다는 뜻이다.

예를 들어, https://moba/users라는 URL에서 신규 유저 추가 API를 설계한다면 다음과 같이 할 수 있다.

...

신규 유저 추가 API

https://moba/users

(1) Request
- Head
Method : POST
...

- Body
{
  "name": "Jerry",
  "email: "jerry@moba.kr",
  "department": "engineering",
}
...

(2) Response
Success인 경우 :
- Head
...
- Body
{
  "id": "[부여된 고유 식별자 값]",
  "name": "Jerry",
  "email": "jerry@moba.kr"
  "department": "engineering",
}
Fail인 경우 :

...

이렇게 해당 서비스에서 제공되는 각 URL에, 어떤 리퀘스트를 보내면, 서버는 어떤 리스폰스를 보내야 하는지를 일일이 설계하는 것이

Web API 설계이다. 실무에서는 예시보다 훨씬 체계적이고 단정한 방식으로, 상용 툴 등을 사용해서 정리한다.

이런 식으로 Web API가 설계되고 나면, 그때 프론트엔드와 백엔드 개발자들이 해당 설계에 맞게 각자 코드를 작성하기 시작한다.

물론 설계와 개발이 동시에 진행되기도 하고, 설계 내용이 중간에 수정되기도 한다. 그럼에도 오늘날 많은 회사 내의 개발팀은 이런 식으로

Web API를 설계하고 웹 서비스를 만든다. Web API가 잘 설계되었는지에 관한 기준으로는 보통 REST API라는 기준을 사용한다.

REST API란?

REST API는 오늘날 많은 웹 개발자들이 Web API 설계를 할 때, 준수하기 위해 노력하는 일종의 가이드라인이다.

REST API를 이해하기 위해서는 일단 REST architecture가 무엇인지부터 알아야 한다. REST architecture란 미국의 컴퓨터 과학자인 Roy

Fielding이 본인의 박사 논문 'Architectural Styles and the Design of Network-based Software Architectures'에서 제시한 개념이다.

그는 웹이 갖추어야 할 이상적인 아키텍처(구조)로 REST architecture라는 개념을 제시했다. 여기서 REST는 Representational State

Transfer(표현적인 상태 이전)의 줄임말로, 해석하면 '표현적인, 상태 이전'이라는 뜻이다. 이는 Roy Fielding이 고안한 용어이다.

만약 웹을 하나의 거대한 컴퓨터 프로그램이라고 생각한다면, 각각의 웹 페이지는 그 프로그램의 내부 상태를 나타낸다고 할 수 있다.

그렇다면 웹 페이지들을 계속 옮겨 다니면서 보게 되는 내용은, 웹이라는 프로그램의 매번 새로운 상태를 나타내는 표현이라고 할 수 있다.

그래서 이것을 '표현적인, 상태 이전'이라고 한다. REST architecture가 되기 위한 조건에는 다음의 6가지 기준이 있다.

 

1. Client-Server

Client-Server 구조를 통해 양측의 관심사를 분리해야 한다. 웹 브라우저가 실행되고 있는 컴퓨터가 Client, 서비스를 제공하는 컴퓨터가

Server에 해당한다. 이렇게 분리를 해놓으면 Client 측은 사용자에게 어떻게 하면 더 좋은 화면을 보여줄지, 다양한 기기에 어떻게 적절하게 대처해야 할지 등의 문제에 집중할 수 있고, Server 측은 서비스에 적합한 구조, 확장 가능한 구조를 어떻게 구축할 것인지 등의 문제에

집중할 수 있다. 이렇게 각자가 서로를 신경 쓰지 않고 독립적으로 운영될 수 있는 구조를 Client-Server 구조라 한다.

 

2. Stateless

Client가 보낸 각 리퀘스트에 관해서 Server는 그 어떤 맥락(context)도 저장하지 않아야 한다. 즉, 매 리퀘스트는 각각 독립적인 것으로

취급되어야 한다. 이 때문에 리퀘스트에는 항상 필요한 모든 정보가 담겨있어야 한다.

 

3. Cache

Cache를 활용해서 네트워크 비용을 절감해야 한다.

Server는 리스폰스에 Client의 리스폰스를 재활용 가능 여부(Cacheable)를 담아서 보내야 한다.

 

4. Uniform Interface

Client가 Server와 통신하는 인터페이스는 다음과 같은 하위 조건 4가지를 준수해야 한다. 이 조건이 REST API와 연관이 깊은 조건이다.

 

4-1. identification of resources

리소스(resource)는 웹상에 존재하는 데이터를 나타내는 용어이다. 이것은 리소스(resource)를 URI(Uniform Resource Identifier)로

식별할 수 있어야 한다는 조건이다.

 

4-2. manipulation of resources through representations

Client와 Server는 리소스를 직접적으로 다루는 게 아니라 리소스의 '표현(representations)'을 다뤄야 한다.

예를 들어, Server에 '오늘 날씨'(/today/weather)라는 리소스를 요청했을 때, 어떤 Client는 HTML 파일을 받을 수도 있고,

어떤 Client는 이미지 파일인 PNG 파일을 받도록 구현할 수도 있다. 이때 HTML 파일과 PNG 파일 같은 것들이 바로 리소스의 '표현'이다.

즉, 동일한 리소스라도 여러 개의 표현이 있을 수 있다는 뜻이다. 사실, 리소스는 웹에 존재하는 특정 데이터를 나타내는 추상적인 개념이다.

실제로 우리가 다루게 되는 것은 리소스의 표현들뿐이다. 이렇게 ‘리소스’와 ‘리소스의 표현'을 엄격하게 구분하는 것이 REST의 특징이다.

 

4-3. self-descriptive messages

self-descriptive는 '자기 설명적인'이라는 뜻으로 Stateless 조건 때문에 Client는 리퀘스트마다 필요한 모든 정보를 담아서 전송해야 한다.

그리고 이때 Client의 리퀘스트와 Server의 리스폰스 모두 그 자체에 있는 정보만으로 모든 것을 해석할 수 있어야 한다.

 

4-4. hypermedia as the engine of application state

REST architecture가 웹이 갖추어야 할 이상적인 아키텍처라고 할 때, '웹'을 좀 더 어려운 말로 풀었어 보자면 '분산 하이퍼미디어

시스템'(Distributed Hypermedia System)이라고도 할 수 있다. 여기서 하이퍼미디어(Hypermedia)는 하이퍼텍스트(Hypertext)처럼

서로 연결된 '문서'에 국한된 것이 아니라 이미지, 소리, 영상 등까지도 모두 포괄하는 더 넓은 개념의 단어이다. 즉, 웹은 수많은 컴퓨터에

하이퍼미디어들이 분산되어 있는 형태이기 때문에, '분산 하이퍼미디어 시스템'에 해당한다. 이 조건은 웹을 하나의 프로그램으로

간주했을 때, Server의 리스폰스에는 현재 상태에서 다른 상태로 이전할 수 있는 링크를 포함하고 있어야 한다는 조건이다.

즉, 리스폰스에는 리소스의 표현, 각종 메타 정보들뿐만 아니라 새로운 상태로 넘어갈 수 있도록 해주는 링크들도 포함되어 있어야 한다.

 

5. Layered System

Client와 Server 사이에는 프록시(proxy)와 게이트웨이(gateway) 같은 중간 매개 요소를 두고,

보안, 로드 밸런싱 등을 수행할 수 있어야 한다. 이를 통해 Client와 Server 사이에는 계층형 층(hierarchical layers)들이 형성된다.

 

6. Code on Demand

Client는 받아서 바로 실행할 수 있는 applet이나 script 파일을 Server로부터 받을 수 있어야 한다. 이 조건은 Optional 한 조건으로

REST architecture가 되기 위해 이 조건이 반드시 만족될 필요는 없다.

 

사실, 오늘날 우리가 Web API를 설계할 때 위의 조건들을 모두 제대로 이해하고 준수하는 것은 쉽지 않은 일이다.

기억해야 할 것은, REST API는 바로 이런 REST architecture에 부합하는 API를 의미한다는 것이다.

그리고 이런 REST API를 사용하는 웹 서비스를 RESTful 서비스라고 한다. Roy Fielding의 논문에는 이것에 관한 구체적이고 실천적인

내용들은 제시되어 있지 않다. 하지만 많은 개발자들의 경험과 논의를 통해 형성된 사실상의(de facto) 규칙들이 존재한다.

그중에서도 조건 4. Uniform Interface의 하위 조건인 (4-1) identificaton of resources에 관해서 특히 개발자들이 강조하는 규칙,

2가지가 있다. 우리 프로젝트에서 적용해볼 것 역시 다음의 2가지이다.

 

(1) URL은 리소스를 나타내기 위해서만 사용하고, 리소스에 대한 처리는 메서드로 표현해야 한다.

이 규칙은 조금 다르게 설명하자면, URL에서 리소스에 대한 처리를 드러내면 안 된다는 규칙이다.

예를 들어, 신규 유저 정보를 추가하기 위해서 다음과 같이 API 문서를 설계한 경우,

(ㄱ) “https://moba/users” URL로

(ㄴ) 리퀘스트의 헤드에 POST 메소드를 설정하고,

(ㄷ) 리퀘스트의 바디에 신규 유저 정보를 넣어서 보내면 된다.

URL은 리소스만 나타내고, 리소스에 대한 처리(리소스 추가)는 메소드 값인 POST로 나타냈기 때문에 이 규칙을 준수한 것이다.

하지만 다음과 같이 설계한 경우,

(ㄱ) “https://moba/users/add” URL로

(ㄴ) 리퀘스트의 헤드에 GET 메소드를 설정하고,

(ㄷ) 리퀘스트의 바디에 신규 유저 정보를 넣어서 보내면 된다.

URL에서 리소스뿐만 아니라, 해당 리소스에 대한 처리(add, 추가하다)까지도 나타내고 있다. 그리고 정작 메소드 값으로는 리소스 추가가 아닌 리소스 조회를 의미하는 GET을 설정했기 때문에 이 규칙을 어긴 것이다.

 

(2) 도큐먼트는 단수 명사로, 컬렉션은 복수 명사로 표시한다.

"https://www.soccer.com/europe/teams/manchester-united/players/pogba"

 

path 부분에서 특정 리소스(pogba, 축구 선수 포그바의 정보)를 나타낼 때 슬래시(/)를 사용해서 계층적인 형태로 나타낸다.

즉, URL을 통해 '유럽의', '축구팀들 중에서', '맨체스터 유나이티드 팀의', '선수들 중', '포그바'라는 선수의 정보를 의미하는 리소스라는 것을

한눈에 알 수 있다. 계층적 관계를 잘 나타내면, URL만으로 무슨 리소스를 의미하는지를 누구나 쉽게 이해할 수 있다. API를 설계할 때는

이렇게 가독성 좋고, 이해하기 쉬운 URL을 설계해야 한다. 그런데 리소스는 그 특징에 따라 여러 종류로 나눠볼 수 있다.

크게 '컬렉션(collection)'과 '도큐먼트(document)'로 나눌 수 있는데, 하나의 객체로 표현할 수 있는 리소스를 '도큐먼트'라고 한다.

그리고 여러 개의 '도큐먼트'를 담을 수 있는 리소스를 '컬렉션'이라고 한다. 쉽게 비유하자면, 도큐먼트는 하나의 '파일',

컬렉션은 여러 '파일'들을 담을 수 있는 하나의 '디렉토리'에 해당하는 개념이다. 그런데 URL에서 '도큐먼트'를 나타낼 때는 단수형 명사를,

'컬렉션'을 나타낼 때는 복수형 명사를 사용해야 한다. 상기 URL에서 europe, manchester-united, pogba가 '도큐먼트'에 해당하고,

teams, players가 '컬렉션'에 해당한다. '도큐먼트', '컬렉션' 개념을 메소드 종류와 연결해서 모든 경우의 수를 생각해보면 다음과 같다.

표에서 보이는 것처럼, 전체 직원 정보를 대상으로 PUT 리퀘스트 또는 DELETE 리퀘스트를 보내는 것은 전체 직원 정보를 모두 수정 또는

모두 삭제한다는 뜻이기 때문에 사실상 잘 쓰이지 않는다. 위험한 동작이기 때문에 애초에 Web API 설계에 반영하지도 않고, 서버에서

허용하지 않을 때가 일반적이다. 주목할 점은 POST 리퀘스트를 보낼 때, 컬렉션(members) 타입의 리소스 대상으로 작업을 수행한다는 점이다. POST 리퀘스트를 보낼 때는 우리가 전체 직원 정보를 의미하는 컬렉션에 하나의 직원 정보(하나의 도큐먼트)를 추가하는 것이기

때문에 URL로는 컬렉션까지만 /members 이렇게 표현해줘야 한다. 따라서 /members/3 처럼 특정 도큐먼트를 나타내는 URL에

POST 리퀘스트를 보내는 것은 문맥상 맞지 않는 표현이다.

 

지금까지 REST API의 조건 중 하나인 4. Uniform Interface을 잘 지키기 위해 개발자들이 강조하는 규칙 2가지였다.

이것만으로 Web API를 REST API로 설계할 수 있는 것은 아니다. 여전히 만족시켜야 하는 다른 조건들도 있다.

REST API는 개발자들이 Web API를 설계할 때 굉장히 중요하게 고려하는 가이드라인이기는 하지만,

앞서 제시한 6가지 조건을 모두 만족시켜가면서까지 100% 준수해야 할 필요성이 있는지에 관해서는 의견이 많다.

우리 프로젝트에서는 다음의 두 가지는 준수하여 API 설계를 진행할 것이다.

(1) URL은 리소스를 나타내기 위해서만 사용하고, 리소스에 대한 처리는 메서드로 표현해야 한다.
(2) 도큐먼트는 단수 명사로, 컬렉션은 복수 명사로 표시한다.