REST API vs GraphQL

박정호·2022년 9월 30일

목록 보기

1/6

🚀 Start

프로젝트를 개발하다보면 프론트엔드와 백엔드 간의 데이터가 오고 가는 것을 확인할 수 있다. 프론트엔드에서는 화면에 보이기 위한 데이터를 요청하고 백엔드에서는 요청에 대한 응답으로 데이터를 보내준다.

이와 같은 과정을 Server API라고 할 수 있다.
Server API란 적절한 요청을 하였을 때, 그에 맞는 응답을 되돌려주는 창구(Endpoint)를 Web을 통해 노출하는 것을 말한다. 이는 정보를 요청하고 수정하기 위해서 만들어지는 경우가 많으며 Server API를 만드는 방법론 중에는 REST와 GraphQL이 있다.

💡 잠깐) API

"Application Programming Interface란 데이터와 기능의 집합을 제공하여 컴퓨터 프로그램간 상호작용을 촉진하며, 서로 정보를 교환가능 하도록 하는 것"

API는 어떠한 응용프로그램에서 데이터를 주고 받기 위한 방법을 의미한다. 어떤 특정 사이트에서 특정 데이터를 공유할 경우 어떠한 방식으로 정보를 요청해야 하는지, 그리고 어떠한 데이터를 제공 받을 수 있을지에 대한 규격들을 API라고 하는것.

✏️ API의 역할

1. API는 서버와 데이터베이스에 대한 출입구 역할을 한다.

데이터베이스에는 소중한 정보들이 저장된다. API는 데이터베이스에 아무나 함부로 데이터베이스에 접근하는 것을 방지하기 위해 서버와 데이터베이스에 대한 출입구 역할을 하며, 허용된 사람들에게만 접근성을 부여한다.

2. API는 애플리케이션과 기기가 원활하게 통신할 수 있도록 한다.

애플리케이션이란 우리가 흔히 알고 있는 스마트폰 어플이나 프로그램을 말한다. API는 애플리케이션과 기기가 데이터를 원활히 주고받을 수 있도록 돕는 역할을 한다.

3. API는 모든 접속을 표준화한다.

API는 모든 접속을 표준화하기 때문에 기계,운영체제 등과 상관없이 누구나 동일한 액세스를 얻을 수 있다. 쉽게 말해, API는 범용 플러그처럼 작동한다고 볼 수 있다.

✏️ API유형

1. private API

private API는 내부 API로, 회사 개발자가 자체 제품과 서비스를 개선하기 위해 내부적으로 발행. 따라서 제 3자에게 노출되지 않는다.

2) public API

public API는 개방형 API로, 모두에게 공개. 누구나 제한 없이 API를 사용할 수 있는 게 특징.

3) partner API

partner API는 기업이 데이터 공유에 동의하는 특정인들만 사용 가능. 비즈니스 관계에서 사용되는 편이며, 종종 파트너 회사 간에 소프트웨어를 통합하기 위해 사용.

⭐️ REST

1️⃣ REST 개념

Representational State Transfer의 약자로, 자원(resource)을 이름으로 구분하여 해당 자원의 상태(정보)를 주고 받는 모든 것을 의미한다. 즉, 리소스의 표현에 의한 상태 전달을 뜻한다.

REST는 Resource들을 하나의 Endpoint에 연결해놓고, 각 Endpoint는 그 Resource와 관련된 내용만 관리하는 방법론이다.

REST는 기본적으로 웹의 기존 기술과 HTTP 프로토콜을 그대로 활용하기 때문에 웹의 장점을 최대한 활용할 수 있는 아키택처 스타일이다.

2️⃣ REST 사용이유

애플리케이션 분리 및 통합
다양한 클라이언트의 등장
최근의 서버 프로그램은 다양한 브라우저와 안드로이폰, 아이폰과 같은 모바일 디바이스에서도 통신을 할 수 있어야 한다.
멀티 플랫폼에 대한 지원을 위해 서비스 자원에 대한 아키텍처를 세우고 이용하는 방법을 모색한 결과, REST에 관심을 가지게 되었다.

3️⃣ REST 구성요소

✏️ 자원(Resource): URI

모든 자원에 고유한 ID가 존재하고, 이 자원은 Server에 존재한다.
자원을 구별하는 ID는 ‘/groups/:group_id’와 같은 HTTP URI 다.
Client는 URI를 이용해서 자원을 지정하고 해당 자원의 상태(정보)에 대한 조작을 Server에 요청한다.

✏️ 행위(Verb): HTTP Method

HTTP 프로토콜의 Method를 사용한다.
HTTP 프로토콜은 GET, POST, PUT, DELETE 와 같은 메서드를 제공한다.

✏️ 표현(Representation of Resource)

Client가 자원의 상태(정보)에 대한 조작을 요청하면 Server는 이에 적절한 응답(Representation)을 보낸다.
REST에서 하나의 자원은 JSON, XML, TEXT, RSS 등 여러 형태의 Representation으로 나타내어 질 수 있다.
JSON 혹은 XML를 통해 데이터를 주고 받는 것이 일반적이다.

4️⃣ REST 특징

✏️ Server-Client(서버-클라이언트 구조)

자원이 있는 쪽이 Server, 자원을 요청하는 쪽이 Client가 된다.
REST Server: API를 제공하고 비즈니스 로직 처리 및 저장을 책임진다.

✏️ Stateless(무상태)

HTTP 프로토콜은 Stateless Protocol이므로 REST 역시 무상태성을 갖는다.
Client의 context를 Server에 저장하지 않는다.
즉, 세션과 쿠키와 같은 context 정보를 신경쓰지 않아도 되므로 구현이 단순해진다.
Server는 각각의 요청을 완전히 별개의 것으로 인식하고 처리한다.
각 API 서버는 Client의 요청만을 단순 처리한다.
즉, 이전 요청이 다음 요청의 처리에 연관되어서는 안된다. 물론 이전 요청이 DB를 수정하여 DB에 의해 바뀌는 것은 허용한다.
Server의 처리 방식에 일관성을 부여하고 부담이 줄어들며, 서비스의 자유도가 높아진다.

✏️ Cacheable(캐시 처리 가능)

웹 표준 HTTP 프로토콜을 그대로 사용하므로 웹에서 사용하는 기존의 인프라를 그대로 활용할 수 있다. 즉, HTTP가 가진 가장 강력한 특징 중 하나인 캐싱 기능을 적용할 수 있다.
HTTP 프로토콜 표준에서 사용하는 Last-Modified 태그나 E-Tag를 이용하면 캐싱 구현이 가능하다.
대량의 요청을 효율적으로 처리하기 위해 캐시가 요구된다.
캐시 사용을 통해 응답시간이 빨라지고 REST Server 트랜잭션이 발생하지 않기 때문에 전체 응답시간, 성능, 서버의 자원 이용률을 향상시킬 수 있다.

✏️ Layered System(계층화)

Client는 REST API Server만 호출한다.
REST Server는 다중 계층으로 구성될 수 있다.
API Server는 순수 비즈니스 로직을 수행하고 그 앞단에 보안, 로드밸런싱, 암호화, 사용자 인증 등을 추가하여 구조상의 유연성을 줄 수 있다. 또한 로드밸런싱, 공유 캐시 등을 통해 확장성과 보안성을 향상시킬 수 있다.
PROXY, 게이트웨이 같은 네트워크 기반의 중간 매체를 사용할 수 있다.

✏️ Code-On-Demand(optional)

Server로부터 스크립트를 받아서 Client에서 실행한다.

✏️ Uniform Interface(인터페이스 일관성)

URI로 지정한 Resource에 대한 조작을 통일되고 한정적인 인터페이스로 수행한다.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
특정 언어나 기술에 종속되지 않는다.

5️⃣ REST 동작

HTTP URI를 통해 리소스를 명시하고, HTTP Method(POST, GET, PUT, DELETE)를 통해 해당 자원에 대한 CRUD Operation을 적용한다.

CRUD Operation

Create : 생성(POST)
Read : 조회(GET)
Update : 수정(PUT)
Delete : 삭제(DELETE)
HEAD: header 정보 조회(HEAD)

각각의 리소스는 URL 끝점으로 정의되고, 해당 끝점에 특정 HTTP Method로서 요청하여 데이터를 검색할 수 있다. 대부분 REST API 서버는 JSON형식으로 데이터를 제공한다.

예시)

글 관련 API = /posts
글 작성 = POST /posts
글 수정 = PATCH /posts/[postid]
글 삭제 = DELETE /posts/[postid]

댓글 관련 API = /posts/[postid]/comments
댓글 작성 = POST /posts/[postid]/comments
댓글 수정 = PATCH /posts/[postid]/comments/[commentid]
댓글 삭제 = DELETE /posts/[postid]/comments/[commentid]

6️⃣ REST 장점

HTTP 프로토콜의 인프라를 그대로 사용하므로 REST API 사용을 위한 별도의 인프라를 구출할 필요가 없다.
HTTP 프로토콜의 표준을 최대한 활용하여 여러 추가적인 장점을 함께 가져갈 수 있게 해준다.
HTTP 표준 프로토콜에 따르는 모든 플랫폼에서 사용이 가능하다.
Hypermedia API의 기본을 충실히 지키면서 범용성을 보장한다.
REST API 메시지가 의도하는 바를 명확하게 나타내므로 의도하는 바를 쉽게 파악할 수 있다.
여러가지 서비스 디자인에서 생길 수 있는 문제를 최소화한다.
서버와 클라이언트의 역할을 명확하게 분리한다.

7️⃣ REST 단점

표준이 존재하지 않는다
사용할 수 있는 메소드가 4가지 밖에 없다.
HTTP Method 형태가 제한적이다.
브라우저를 통해 테스트할 일이 많은 서비스라면 쉽게 고칠 수 있는 URL보다 Header 값이 왠지 더 어렵게 느껴진다.
구형 브라우저가 아직 제대로 지원해주지 못하는 부분이 존재한다.
pushState를 지원하지 않는 점

⭐️ REST API

1️⃣ REST API 정의

REST 기반으로 서비스 API를 구현한 것

최근 OpenAPI(누구나 사용할 수 있도록 공개된 API: 구글 맵, 공공 데이터 등), 마이크로 서비스(하나의 큰 애플리케이션을 여러 개의 작은 애플리케이션으로 쪼개어 변경과 조합이 가능하도록 만든 아키텍처) 등을 제공하는 업체 대부분은 REST API를 제공한다.

2️⃣ REST API 특징

사내 시스템들도 REST 기반으로 시스템을 분산해 확장성과 재사용성을 높여 유지보수 및 운용을 편리하게 할 수 있다.
REST는 HTTP 표준을 기반으로 구현하므로, HTTP를 지원하는 프로그램 언어로 클라이언트, 서버를 구현할 수 있다.
즉, REST API를 제작하면 델파이 클라이언트 뿐 아니라, 자바, C#, 웹 등을 이용해 클라이언트를 제작할 수 있다.

3️⃣ REST API 기본 규칙

✏️ 참고 리소스 원형

도큐먼트 : 객체 인스턴스나 데이터베이스 레코드와 유사한 개념
컬렉션 : 서버에서 관리하는 디렉터리라는 리소스
스토어 : 클라이언트에서 관리하는 리소스 저장소

✏️ URI는 정보의 자원을 표현해야 한다.

resource는 동사보다는 명사를, 대문자보다는 소문자를 사용한다.
resource의 도큐먼트 이름으로는 단수 명사를 사용해야 한다.
resource의 컬렉션 이름으로는 복수 명사를 사용해야 한다.
resource의 스토어 이름으로는 복수 명사를 사용해야 한다.

Ex) GET /Member/1 -> GET /members/1

✏️ 자원에 대한 행위는 HTTP Method(GET, PUT, POST, DELETE 등)로 표현한다.

URI에 HTTP Method가 들어가면 안된다.

Ex) GET /members/delete/1 -> DELETE /members/1

URI에 행위에 대한 동사 표현이 들어가면 안된다.(즉, CRUD 기능을 나타내는 것은 URI에 사용하지 않는다.)

Ex) GET /members/show/1 -> GET /members/1
Ex) GET /members/insert/2 -> POST /members/2

경로 부분 중 변하는 부분은 유일한 값으로 대체한다.(즉, :id는 하나의 특정 resource를 나타내는 고유값이다.)

Ex) student를 생성하는 route: POST /students
Ex) id=12인 student를 삭제하는 route: DELETE /students/12

4️⃣ REST API 설계 규칙

✏️ 슬래시 구분자( / )는 계층 관계를 나타내는데 사용한다.

Ex) http://restapi.example.com/houses/apartments

✏️ URI 마지막 문자로 슬래시( / )를 포함하지 않는다.

URI에 포함되는 모든 글자는 리소스의 유일한 식별자로 사용되어야 하며 URI가 다르다는 것은 리소스가 다르다는 것이고, 역으로 리소스가 다르면 URI도 달라져야 한다.
REST API는 분명한 URI를 만들어 통신을 해야 하기 때문에 혼동을 주지 않도록 URI 경로의 마지막에는 슬래시(/)를 사용하지 않는다.

Ex) http://restapi.example.com/houses/apartments/ (X)

✏️ 하이픈(- )은 URI 가독성을 높이는데 사용

불가피하게 긴 URI경로를 사용하게 된다면 하이픈을 사용해 가독성을 높인다.

✏️ 밑줄(_ )은 URI에 사용하지 않는다.

밑줄은 보기 어렵거나 밑줄 때문에 문자가 가려지기도 하므로 가독성을 위해 밑줄은 사용하지 않는다.

✏️ URI 경로에는 소문자가 적합하다.

URI 경로에 대문자 사용은 피하도록 한다.
RFC 3986(URI 문법 형식)은 URI 스키마와 호스트를 제외하고는 대소문자를 구별하도록 규정하기 때문

✏️ 파일확장자는 URI에 포함하지 않는다.

REST API에서는 메시지 바디 내용의 포맷을 나타내기 위한 파일 확장자를 URI 안에 포함시키지 않는다.
Accept header를 사용한다.

Ex) http://restapi.example.com/members/soccer/345/photo.jpg (X)
Ex) GET / members/soccer/345/photo HTTP/1.1 Host: restapi.example.com Accept: image/jpg (O)

✏️ 리소스 간에는 연관 관계가 있는 경우

/리소스명/리소스 ID/관계가 있는 다른 리소스명

Ex) GET : /users/{userid}/devices (일반적으로 소유 ‘has’의 관계를 표현할 때)

💡 참고 응답상태코드
1xx : 전송 프로토콜 수준의 정보 교환
2xx : 클라어인트 요청이 성공적으로 수행됨
3xx : 클라이언트는 요청을 완료하기 위해 추가적인 행동을 취해야 함
4xx : 클라이언트의 잘못된 요청
5xx : 서버쪽 오류로 인한 상태코드

⭐️ RESTful

RESTful은 일반적으로 REST라는 아키텍처를 구현하는 웹 서비스를 나타내기 위해 사용되는 용어

‘REST API’를 제공하는 웹 서비스를 ‘RESTful’하다고 할 수 있다.
RESTful은 REST를 REST답게 쓰기 위한 방법으로, 누군가가 공식적으로 발표한 것이 아니다.
즉, REST 원리를 따르는 시스템은 RESTful이란 용어로 지칭된다.

💡 중요)
REST의 조건을 만족하는 API를 RESTful API라고 부르고, 이런 방식으로 API를 작성하는 것을 RESTful이라고 하는 것이다.

✏️ RESTful의 목적

이해하기 쉽고 사용하기 쉬운 REST API를 만드는 것
RESTful한 API를 구현하는 근본적인 목적이 성능 향상에 있는 것이 아니라 일관적인 컨벤션을 통한 API의 이해도 및 호환성을 높이는 것이 주 동기이니, 성능이 중요한 상황에서는 굳이 RESTful한 API를 구현할 필요는 없다.

✏️ RESTful이 아닌 경우

Ex1) CRUD 기능을 모두 POST로만 처리하는 API
Ex2) route에 resource, id 외의 정보가 들어가는 경우(/students/updateName)

⭐️ GraphQL

1️⃣ GraphQL 개념

GraphQL(Graph Query Language) 은 API를 위한 쿼리 언어(Query Language)이며 타입 시스템을 사용하여 쿼리를 실행하는 서버사이드 런타임

GraphQL은 특정한 데이터베이스나 특정한 스토리지 엔진과 관계되어 있지 않으며 기존 코드와 데이터에 의해 대체된다.

SQL이 데이터베이스 시스템으로부터 데이터를 가져오는 목적을 가진다면, GraphQL은 클라이언트가 데이터를 서버로부터 효율적으로 가져오는 것을 목적으로 하는 REST API의 한계점을 해결하는 API를 위한 쿼리언어이다.

💡 잠깐) 쿼리 언어(Query Language)

쿼리 언어는 정보를 얻기 위해 보내는 질의문(query)를 만들기 위해 사용되는 컴퓨터 언어이다.
가장 잘 알려져있는 예시로는 데이터베이스 시스템에 저장된 데이터를 가져오기 위해 사용하는 SQL이 있다.

2️⃣ GraphQL 사용이유

🥲 앞서 바라본 REST API에는 한계가 있다. 리소스들이 하나의 endpoint에 연결되어있는 REST API는 단순한 서비스에는 아주 좋지만 복잡한 서비스나 클라이언트 요청사항에 따라서Over-Fetching과 Under-Fetching이 발생한다.

또한 REST API로 여러 환경에서 필요한 정보들을 Resource별로 Endpoint를 갖도록 구현하는 것이 어려워, Endpoint가 다른 API가 많이 파생된다.

😃 So, GraphQL에서는 API서버에서 엄격하게 정의된 endpoint 들에 요청하는 대신, 한번의 요청으로 정확히 가져오고 싶은 데이터를 가져올 수 있게 도와주는 쿼리를 보낼 수 있게 한다.

⭐️ 즉, Endpoint는 1개만 생성하고 클라이언트에게 필요한 데이터는 클라이언트가 직접 쿼리를 작성,호출하여 반환 받는 것이다. 따라서, user에 대한 몇 가지의 간단한 데이터가 필요할 때, 필요한 만큼의 user 정보를 최적화하여 가져올 수 있다.

💡 잠깐) Under Fetcing & Over Fetching

✏️ UnderFetching
하나의 endpoint로 필요한 모든 데이터 요청을 처리하지 못한다는 의미. 여러 번의 API 호출이 필요하므로 요청 횟수가 증가한다는 문제가 발생

EX) SNS 어플을 켰을 때, 타임라인을 보여주기 위해서 알림 정보, 사용자 정보, 타임라인 등 각 정보를 가져올 수 있는 API를 여러 번 요청하는 것.

EX) 쇼핑몰 서비스의 경우, 로그인한 사용자의 장바구니 정보를 보여준다고 가정하면 여러 API를 호출하게 된다.요청에 맞게 유효한 데이터를 보여주기 위해 여러 API를 호출하게 되는 경우를 Under-Fetching이라 한다.
/user/1/

/cart/

/notification/

/wish/

...
✏️ OverFetching
endpoint로 요청하여 응답 받은 정보가 사용하지 않을 불필요한 데이터를 담고 있는 경우. 필요없는 데이터를 전송하기 때문에 네트워크 낭비가 발생.

EX) 사용자의 데이터를 조회하는 /user/ API가 있다고 가정한다. 이 때, 사용자 번호: 1 에 해당하는 데이터를 조회한다면 아래와 같은 형태가 됩니다.

여기서 클라이언트에서는 1번에 해당하는 유저의 이름만을 사용하고자 한다고 해도 유저 이름만 반환하는 API가 없다면 위와 같은 /user/1/ API를 호출한 다음, user_name을 가져와 사용해야 한다. 이때, user_grade, zip 등등의 데이터는 사용하지 않는 데이터도 같이 반환받는다. 이는 곧 리소스의 낭비라고 볼 수 있고 이와 같은 낭비를 Over-Fetching이라 힌다.
GET /user/1/
response body 
{
 "user_no": 1,
 "user_name": "test",
 "usere_grade": "VVIP",
 "zip": "11053",
 "last_login_timestamp": "2019-08-08 12:11:44",
 ...
}

3️⃣ GraphQL 구조

Query (쿼리 = 데이터)
Mutation (변형)
Subscription (설명)

Query 는 객체 구조로 표현한다. Query는 읽기를 요청하는 구문이고 Mutation은 수정을 요청하는 구문이다.

Mutation을 통해 쿼리들을 추가 할 수도 삭제 할 수도 있다. GraphQL 서버에서는 정적인 타입 시스템을 사용해 데이터를 표현하는 Schema가 존재하고, 각 타입의 필드에 대한 함수로 구성된다. 그리고 하나의 EndPoint를 사용함으로써 RESTful API에서 생기는 많은 Enpoint의 복잡성을 줄여줄 수 있다.

4️⃣ GraphQL 장점

✏️ HTTP 요청 횟수를 줄일 수 있다.

RESTful의 경우 필요한 리소스 별로 요청 해야하고, 필요한 데이터들이 부분적으로 나눠서 개발되어 있다면 그만큼 요청 횟수가 늘어난다. 하지만 GraphQL은 원하는 정보를 하나의 쿼리에 모두 담아 요청 할 수 있다.

✏️ HTTP 응답 사이즈를 줄일 수 있다.

Restful의 경우 응답의 형태가 정해져있기 때문에 필요한 정보만 부분적으로 요청하는 것이 힘들고, 자연스럽게 데이터의 사이즈가 클 수 밖에 없다. Facebook이 GraphQL을 개발한 초기 이유 중 하나는 모바일 사용의 증가라고 한다. GraphQL을 사용함으로써 응답 데이터 사이즈를 최소화하여 모바일 환경의 부담을 줄일 수 있다.

✏️ 프론트엔드와 백엔드 개발자의 부담을 덜 수 있다.

Restful API를 사용한다면 프론트엔드 개발자는 API의 request/response 형식에 의존하게 된다. 따라서 새로운 엔드포인트를 효율적이게 개발하기 위해서는 프론트엔드와 백엔드 개발자의 커뮤니케이션이 강제되는 경우가 많았다.하지만 GraphQL은 request/response 의존도가 많이 없기 때문에, 개발자들의 API 개발 부담을 덜 수 있다.

✏️ GraphQL은 번거로운 오버패치와 언더패치의 단점들을 해결

GraphQL은 Over-fetching 없이 코드를 짤 수 있고 개발자가 어떤 정보를 원하는지에 대해 통제할 수도 있다. 그리고 Under-fetching을 겪을 필요도 없다. 한 쿼리에 내가 정확하게 원하는 정보만 받을 수 있다. 백엔드 개발자는 API 만들기에 쉽고 프론트엔드 개발자는 구체적이고 정확하게 받아오고 싶은 데이터들만 사용 가능하여 백엔드와 프론트 개발자 모두에게 편리

5️⃣ GraphQL 단점

고정된 요청과 응답만 필요할 때에는 query로 인해 요청의 크기가 Restful보다 커질 수 있다.
캐싱이 REST보다 복잡하다.
파일 업로드 구현 방법이 정해져있지 않아 직접 구현해야 한다.

⭐️ GraphQL vs REST API

✏️ REST에서는 Resource에 대한 형태 정의와 데이터 요청 방법이 연결되어 있지만, GraphQL에서는 Resource에 대한 형태 정의와 데이터 요청이 완전히 분리되어 있다.

✏️ REST에서는 Resource의 크기와 형태를 서버에서 결정하지만, GraphQL에서는 Resource에 대한 정보만 정의하고, 필요한 크기와 형태는 client단에서 요청 시 결정한다.

✏️ REST에서는 URI가 Resource를 나타내고 Method가 작업의 유형을 나타내지만, GraphQL에서는 GraphQL Schema가 Resource를 나타내고 Query, Mutation 타입이 작업의 유형을 나타낸다.

✏️ REST에서는 여러 Resource에 접근하고자 할 때 여러 번의 요청이 필요하지만, GraphQL에서는 한번의 요청에서 여러 Resource에 접근할 수 있다.

✏️ REST에서 각 요청은 해당 엔드포인트에 정의된 핸들링 함수를 호출하여 작업을 처리하지만, GraphQL에서는 요청 받은 각 필드에 대한 resolver를 호출하여 작업을 처리합니다.

💡 간단 비교

REST API 요청

GET, https://swapi.dev/api/people/1

REST API 결과

필요한 정보 이외에도 많은 정보가 함께 받아와진다.

{
    "name": "Luke Skywalker",
    "height": "172",
    "mass": "77",
    "hair_color": "blond",
    "skin_color": "fair",
    "eye_color": "blue",
    "birth_year": "19BBY",
    "gender": "male",
    "homeworld": "http://swapi.dev/api/planets/1/",
    "films": ["http://swapi.dev/api/films/1/", "http://swapi.dev/api/films/2/", "http://swapi.dev/api/films/3/", "http://swapi.dev/api/films/6/"],
    "species": [],
    "vehicles": ["http://swapi.dev/api/vehicles/14/", "http://swapi.dev/api/vehicles/30/"],
    "starships": ["http://swapi.dev/api/starships/12/", "http://swapi.dev/api/starships/22/"],
    "created": "2014-12-09T13:50:51.644000Z",
    "edited": "2014-12-20T21:17:56.891000Z",
    "url": "http://swapi.dev/api/people/1/"
}

GraphQL 요청

query {
    person(personID: 1) {
        name
        height
        mass
    }
}

GraphQL 결과

{
    "data": {
        "person": {
            "name": "Luke Skywalker",
            "height": 172,
            "mass": 77
        }
    }
}

1️⃣ Resources

👉 REST 예시

대부분의 REST API에서는 author를 다른 리소스로 분리해둔다. 그리고 리소스의 타입 또는 형태와 리소스를 가져오는 방식이 연결되어 있다.
/books 라는 리소스를 요청 하면 위의 JSON 파일의 형태의 데이터가 주어지게 된다.

GET /books/1

{
  "title": "Romance of the Three Kingdoms",
  "author": {
    "firstName": "Luo",
    "lastName": "Guanzhong"
  }
}

👉 GraphQL 예시

Book과 Author라는 타입을 정의해야 한다. GraphQL에서는 리소스의 유형과 리소스를 가져오는 방식이 완전하게 분리되어 있다.

GET /books/1

type Book {
  id: ID
  title: String
  author: Author
}
type Author {
  id: ID
  firstName: String
  lastName: String
  books: [Book]
}

Book과 Author의 형태만을 정의했지, client에서 데이터를 어떻게 요청할 수 있는 지에 대해서는 아무런 정보가 없다. Book과 Author에 접근할 수 있도록, Query라는 타입이 필요하다.

type Query {
  book(id: ID!): Book
  author(id: ID!): Author
}

그러면 이제 REST와 비슷한 방식으로 요청이 가능하다.

/graphql?query={ book(id: "1") { title, author { firstName } } }

{
  "title": "Black Hole Blues",
  "author": {
    "firstName": "Janna"
  }
}

⭐️ REST와는 다르게 /books등과 같이 각 Resource에 대한 엔드포인트가 따로 존재하지 않고, 하나의 엔드포인트만 존재한다. 또한 해당 엔드포인트로 요청 시, 원하는 리소스와 해당 리소스에서 원하는 필드를 특정하는 GraphQL query를 함께 보낸다.
위의 gql을 통해, id = 1 인 book의 title과 author의 firstName 만 가져올 수 있었다.

2️⃣ API 서비스 명세

API는 요청할 수 있는 리소스가 어떤 것이 있고, 어떤 리소스에 어떤 요청을 했을 때 어떠한 결과가 나에게 전달되는 지를 모르면, 당연히 아무 쓸모가 없다.
모든 API 서비스는 해당 API에 대한 명세가 있다. GraphQL에서는 GraphQL introspection이, REST API 에서는 Swagger가 문서화를 쉽게 도와준다. 또한,
문서화 뿐만 아니라, 실제 요청을 테스트해 볼 수도 있도록 도와준다.

👉 REST API

REST API에서는 어떤 데이터를 조회하거나 추가하는 것과 같은 작업을 진행하고자 할 때, 제일 먼저 생각해야 하는 것은 어떤 엔드포인트로 요청을 보내야하는지이다. 각 엔드포인트는 해당 리소스를 가리키며, 요청의 HTTP method에 따라 어떤 작업을 진행하는 지 달라진다.

👉 GraphQL

GraphQL에서는 URL을 Resource를 특정 짓는 것에 사용하지 않는다. GraphQL Schema가 Resource를 특정 짓는다. 또한, HTTP Method로 어떤 작업을 진행하게 되는지 구분하지 않고, Query, Mutation이라는 타입을 사용해 구분한다.

👉 GraphQL은 한번의 요청으로 여러 resource에 대해 접근할 수 있다. 반면에 REST API에서 여러 리소스에 접근하고자 한다면 여러 번의 요청은 불가피하다.

💡 중요) 어떤 것을 사용해야 할까?

✏️ GraphQL

서로 다른 모양의 다양한 요청들에 대해 응답할 수 있어야 할 때

대부분의 요청이 CRUD(Create-Read-Update-Delete) 에 해당할 때

✏️ RESTful

HTTP 와 HTTPs 에 의한 Caching 을 잘 사용하고 싶을 때

File 전송 등 단순한 Text 로 처리되지 않는 요청들이 있을 때

요청의 구조가 정해져 있을 때

그렇다고 정답이 정해져 있는 것은 아니다. 하지만, 두 API structure를 섞어서 사용하는 것은 좋지 않으며, 어떤 목적으로 사용할 것인지에 따라 잘 사용하는 것이 중요하다.

참조 및 참고하기 좋은 사이트

https://hwasurr.io/api/rest-graphql-differences/

https://hceaan.tistory.com/134

https://steemit.com/kr/@yahweh87/it-api

https://blog.wishket.com/api%EB%9E%80-%EC%89%BD%EA%B2%8C-%EC%84%A4%EB%AA%85-%EA%B7%B8%EB%A6%B0%ED%81%B4%EB%9D%BC%EC%9D%B4%EC%96%B8%ED%8A%B8/

https://gmlwjd9405.github.io/2018/09/21/rest-and-restful.html

https://hahahoho5915.tistory.com/63 [넌 잘하고 있어:티스토리]

https://brownbears.tistory.com/450

https://1eemember.tistory.com/54![](https://velog.velcdn.com/images/pjh1011409/post/8b3614e5-a160-41c5-a76d-d80a0f33c606/image.png)

박정호

기록하여 기억하고, 계획하여 실천하자. will be a FE developer (HOME버튼을 클릭하여 Notion으로 놀러오세요!)

다음 포스트