Blog

Django REST Framework 소개

Django REST Framework(DRF)는 Django 기반의 웹 애플리케이션에서 RESTful API를 간편하게 구축할 수 있도록 지원하는 오픈 소스 라이브러리입니다. REST(Representational State Transfer)는 웹에서 자원(resource)을 HTTP 프로토콜을 통해 전송하기 위한 아키텍처 스타일을 의미합니다. RESTful API는 이러한 REST 원칙을 준수하여 설계된 API로, 유연성과 효율성을 제공하여 다양한 클라이언트에서 쉽게 접근할 수 있습니다.

RESTful API의 기본 개념

RESTful API는 HTTP 메소드를 사용하여 다양한 요청을 처리합니다. 기본적으로 다음과 같은 네 가지 HTTP 메소드가 있습니다:

• GET: 서버에서 자원의 정보를 요청합니다.
• POST: 새로운 데이터를 서버에 추가합니다.
• PUT: 기존 데이터를 수정합니다.
• DELETE: 특정 데이터를 삭제합니다.

이러한 메소드를 활용해 URIs를 설계하여 API를 구축합니다. 예를 들어, 사용자의 정보를 관리하는 API를 만들고자 한다면 다음과 같은 URL 구조를 고려할 수 있습니다:

• GET /users/: 모든 사용자 목록을 조회합니다.
• POST /users/: 새 사용자를 등록합니다.
• PUT /users/{id}/: 특정 사용자의 정보를 수정합니다.
• DELETE /users/{id}/: 특정 사용자를 삭제합니다.

Django REST Framework 설치 및 설정

DRF를 사용하기 위해서는 먼저 Django 환경을 설정해야 합니다. 아래는 그 과정입니다:

1. 프로젝트를 위한 빈 폴더를 생성합니다.
2. 해당 폴더에서 가상 환경을 생성하고 활성화합니다.
3. 필요한 패키지를 설치합니다: pip install django djangorestframework
4. Django 프로젝트 및 앱을 생성합니다: django-admin startproject myproject 및 python manage.py startapp api

이후 settings.py 파일을 수정하여 REST Framework와 생성한 앱을 추가해야 합니다:

INSTALLED_APPS = [
  ...
  'rest_framework',
  'api',
]

Django 모델 및 직렬화 구성

API에서 데이터를 관리하기 위해 Django 모델을 정의합니다. 예를 들어, 상품 정보를 관리하는 모델을 아래와 같이 구성할 수 있습니다:

from django.db import models
class Product(models.Model):
  name = models.CharField(max_length=100)
  description = models.TextField(max_length=300)
  price = models.DecimalField(max_digits=10, decimal_places=2)

그 후, 직렬화(serialization)를 통해 모델 데이터를 JSON 형식으로 변환할 수 있도록 serializers.py 파일을 생성합니다:

from rest_framework import serializers
from .models import Product
class ProductSerializer(serializers.ModelSerializer):
  class Meta:
    model = Product
    fields = '__all__'

뷰(View) 생성 및 URL 라우팅

이제 API의 로직을 처리할 뷰를 작성해야 합니다. DRF의 제네릭 뷰를 활용하여 CRUD 기능을 간단히 구현할 수 있습니다:

from rest_framework import generics
from .models import Product
from .serializers import ProductSerializer
class ProductListCreateView(generics.ListCreateAPIView):
  queryset = Product.objects.all()
  serializer_class = ProductSerializer
class ProductDetailView(generics.RetrieveUpdateDestroyAPIView):
  queryset = Product.objects.all()
  serializer_class = ProductSerializer

마지막으로, urls.py 파일에서 URL과 뷰를 연결합니다:

from django.urls import path
from .views import ProductListCreateView, ProductDetailView
urlpatterns = [
  path('products/', ProductListCreateView.as_view(), name='product-list'),
  path('products//', ProductDetailView.as_view(), name='product-detail'),
]

서버 실행 및 API 확인

이제 모든 설정이 완료되었습니다. 서버를 실행하려면 다음 명령어를 입력합니다:

python manage.py runserver

이후 웹 브라우저를 통해 http://localhost:8000/products/에 접속하면 API의 정상 동작 여부를 확인할 수 있습니다. JSON 형식으로 상품 목록이 출력되어야 합니다.

결론

Django REST Framework를 활용하면 RESTful API를 구축하는 과정이 비교적 간편해집니다. 위의 과정을 통해 Django로 API를 설정하고, 데이터 모델을 생성하며, 뷰를 작성하고 URL을 라우팅하는 전체적인 흐름을 이해할 수 있었습니다. 이 과정을 바탕으로 더 복잡한 API를 구축하고, 다양한 기능을 추가해보시는 것을 추천드립니다.

자주 묻는 질문 FAQ