백엔드 개발 일지

백엔드 개발에서 API 설계는 중요한 요소 중 하나입니다. 특히 REST API와 GraphQL은 가장 많이 사용되는 두 가지 방법론입니다. 각각의 장단점이 존재하므로, 특정 상황에서 어떤 것을 선택해야 할지에 대한 고민이 필요합니다. 이번 글에서는 REST API와 GraphQL의 특징, 장단점, 그리고 각각을 선택해야 하는 상황에 대해 살펴보겠습니다.

REST API

REST(Representational State Transfer)는 웹 서비스 아키텍처 스타일로, HTTP 프로토콜을 기반으로 합니다. REST API는 리소스(데이터)를 URI(Uniform Resource Identifier)를 통해 접근하고, HTTP 메서드(GET, POST, PUT, DELETE 등)를 사용하여 이를 조작합니다.

장점

단순함: REST는 HTTP 프로토콜을 따르므로, 기본적인 웹 기술을 알고 있는 개발자라면 쉽게 이해하고 사용할 수 있습니다.
캐싱: REST API는 HTTP의 캐싱 메커니즘을 활용할 수 있어, 서버의 부하를 줄이고 응답 속도를 높일 수 있습니다.
명확한 구조: URI와 HTTP 메서드의 조합을 사용하여 리소스에 대한 명확한 접근 방식을 제공합니다.

단점

과다한 데이터 전송: 클라이언트가 필요한 데이터보다 더 많은 데이터를 받을 수 있습니다. 예를 들어, 사용자 정보를 요청할 때 모든 필드를 보내는 형식으로 응답받는 경우입니다.
버전 관리의 어려움: 새로운 기능이나 변경이 필요할 때, 기존 API와의 호환성을 유지하기가 어려울 수 있습니다.
복잡한 엔드포인트: 다양한 리소스를 다루기 위해 여러 개의 엔드포인트를 만들어야 할 수 있습니다.

예제

아래는 REST API를 통해 사용자 정보를 가져오는 예제입니다.

from flask import Flask, jsonify

app = Flask(__name__)

@app.route('/users/<int:user_id>', methods=['GET'])
def get_user(user_id):
    # 예시 데이터
    users = {
        1: {'name': 'Alice', 'age': 30},
        2: {'name': 'Bob', 'age': 25},
    }
    return jsonify(users.get(user_id, {}))

if __name__ == '__main__':
    app.run(debug=True)

GraphQL

GraphQL은 페이스북에서 개발한 API 쿼리 언어로, 클라이언트가 필요한 데이터 구조를 정의할 수 있도록 합니다. 즉, 클라이언트는 요청 시 원하는 필드만 선택하여 서버에 보낼 수 있습니다.

장점

효율적인 데이터 전송: 클라이언트가 필요한 데이터만 요청할 수 있기 때문에, 불필요한 데이터 전송을 줄일 수 있습니다.
단일 엔드포인트: 모든 데이터 요청이 단일 엔드포인트를 통해 이루어지므로, 엔드포인트 관리가 용이합니다.
강력한 타입 시스템: GraphQL은 스키마를 사용하여 API의 구조를 정의하고, 클라이언트는 이를 통해 API의 데이터 형태를 쉽게 이해할 수 있습니다.

단점

복잡성: GraphQL은 REST보다 복잡한 구조를 가지고 있어, 처음 배울 때에는 학습 곡선이 존재할 수 있습니다.
캐싱의 어려움: 클라이언트가 요청하는 데이터의 형태가 다양하기 때문에, 전통적인 캐싱 전략을 적용하기가 어렵습니다.
과도한 요청: 클라이언트가 잘못된 쿼리를 작성할 경우, 서버에 불필요한 부하를 줄 수 있습니다.

예제

아래는 GraphQL을 통해 사용자 정보를 가져오는 예제입니다.

query {
  user(id: 1) {
    name
    age
  }
}

서버에서는 다음과 같이 구현할 수 있습니다.

from flask import Flask
from flask_graphql import GraphQLView
from graphene import ObjectType, String, Int, Schema

class User(ObjectType):
    id = Int()
    name = String()
    age = Int()

users = {
    1: User(id=1, name='Alice', age=30),
    2: User(id=2, name='Bob', age=25),
}

class Query(ObjectType):
    user = String(id=Int(required=True))

    def resolve_user(self, info, id):
        user = users.get(id)
        if user:
            return user.name
        return None

schema = Schema(query=Query)

app = Flask(__name__)
app.add_url_rule('/graphql', view_func=GraphQLView.as_view('graphql', schema=schema, graphiql=True)

if __name__ == '__main__':
    app.run(debug=True)

어떤 상황에서 무엇을 선택할까?

단순한 CRUD 애플리케이션: REST API가 적합합니다. 구현이 간단하고, HTTP 프로토콜의 특성을 잘 활용할 수 있습니다.
복잡한 데이터 요구사항: GraphQL이 더 유리합니다. 클라이언트가 필요한 데이터만 요청할 수 있기 때문입니다.
API 변화에 유연하게 대응해야 하는 경우: GraphQL이 좋습니다. 클라이언트가 필요한 필드만 변경할 수 있어, 서버의 구조에 대한 영향을 최소화할 수 있습니다.
기존 RESTful 서비스와의 통합이 필요한 경우: REST API가 더 나을 수 있습니다. 기존 시스템과의 호환성을 유지하는 것이 중요합니다.

마무리

REST API와 GraphQL은 각기 장단점이 있으며, 상황에 따라 적절한 선택이 필요합니다. API 설계 시 요구사항을 면밀히 분석하고, 팀의 기술 스택과 리소스를 고려하여 최적의 방법을 선택하는 것이 중요합니다. 다양한 케이스를 경험하고, 필요에 따라 두 가지 접근 방식을 혼합하여 사용할 수도 있습니다. 백엔드 개발자로서 이러한 선택지를 잘 활용할 수 있도록 지속적으로 학습하고 경험을 쌓아가길 바랍니다.

REST API와 GraphQL, 어떤 상황에서 무엇을 선택할까?

REST API

장점

단점

예제

GraphQL

장점

단점

예제

어떤 상황에서 무엇을 선택할까?

마무리