[nodejs] REST API를 위한 GraphQL 적용 방법

21 Dec 2023

nodejs

REST (Representational State Transfer) API는 많은 웹 애플리케이션에서 표준적으로 사용되고 있는 API 디자인 패턴입니다. 그러나 GraphQL은 데이터를 효율적으로 가져오고 조작할 수 있는 새로운 방식을 제공하는데, RESTful한 API를 사용하는 애플리케이션을 업그레이드하고자 하는 경우 GraphQL을 고려할 가치가 있습니다.

GraphQL이란 무엇인가?

GraphQL은 페이스북에서 만든 쿼리 언어로, 클라이언트에서 요청한 데이터의 구조를 정확하게 정의할 수 있게 해줍니다. 이는 클라이언트가 단일 요청으로 여러 종류의 데이터를 가져오거나 수정할 수 있도록 지원합니다. 이로써 필요 이상으로 많은 데이터를 가져오는 문제를 해결할 수 있습니다.

GraphQL을 REST API에 적용하는 방법

GraphQL을 REST API에 적용하는 것은 몇 가지 단계를 거치게 됩니다.

GraphQL 서버 설정: Node.js에서는 express-graphql 패키지를 사용하여 GraphQL 서버를 구성할 수 있습니다.

 const express = require('express');
 const { graphqlHTTP } = require('express-graphql');
 const schema = require('./schema'); // GraphQL 스키마 파일

 const app = express();

 app.use('/graphql', graphqlHTTP({
   schema,
   graphiql: true,
 }));

 app.listen(4000, () => {
   console.log('GraphQL Server is running on http://localhost:4000/graphql');
 });

RESTful 엔드포인트 대체: GraphQL 서버를 설정한 후 기존 REST API 엔드포인트를 GraphQL 스키마와 매핑합니다. 예를 들어, /users 엔드포인트에 대한 GraphQL 쿼리를 작성하여 해당 RESTful한 리소스에 접근할 수 있습니다.
GraphQL 쿼리 작성: 클라이언트는 GraphQL 쿼리를 작성하여 필요한 데이터를 서버로 요청합니다. 아래는 간단한 GraphQL 쿼리의 예시입니다.
```
query {
  user(id: 123) {
    id
    name
    email
  }
}
```
데이터 수정 및 캐싱: REST API를 GraphQL로 변경하면서 데이터를 수정하거나 캐싱 등의 부가적인 작업을 처리해야 합니다.

마무리

GraphQL을 REST API에 적용하는 것은 기존 RESTful한 API의 한계를 극복하고 더 유연한 데이터 요청을 가능케 합니다. 그러나 기존 RESTful한 API와의 호환성 유지, 데이터 수정 작업 등 몇 가지 고려사항이 있으므로 전환하기 전에 신중한 계획이 필요합니다.

이 문서는 GraphQL을 REST API에 적용하는 방법을 간략히 설명했습니다. GraphQL을 사용하면 RESTful한 API의 한계를 극복하고 클라이언트가 더 유연하게 데이터를 요청할 수 있는 장점이 있습니다.

참고 문헌:

이상입니다.