[250131] django DRF(Django Rest Framework)란~

Django REST Framework (DRF)란?

1. DRF 정의

Django REST Framework(DRF)는 Django에서 RESTful API를 쉽게 개발할 수 있도록 도와주는 라이브러리이다.

Django의 기본 기능을 확장하여 JSON 응답, 인증, 권한 관리, 페이징, 직렬화(Serializer) 등 다양한 기능을 제공한다.

---

2. DRF를 사용하는 이유

Django는 본래 서버 측 렌더링을 위한 웹 프레임워크이지만, RESTful API 개발을 위해 사용하려면 추가적인 작업이 필요함.
DRF는 이런 과정을 쉽게 만들어주며, API 개발을 위한 다음과 같은 강력한 기능을 제공한다.

 

✅ 직렬화(Serialization) → JSON 데이터 변환을 쉽게 처리
✅ 인증 및 권한 관리 → 기본 제공되는 인증 시스템(OAuth, JWT 등)
✅ ViewSet 및 Generic Views → 코드 중복을 줄이고 효율적으로 개발
✅ API 브라우저 UI 제공 → 개발 및 디버깅이 편리
✅ 페이징, 필터링, 검색 기능 제공

---

3. DRF 설치

pip install djangorestframework

그리고 `settings.py`에 DRF를 등록해준다.

INSTALLED_APPS = [
    'rest_framework',  # Django REST framework 추가
]

---

4. DRF 기본 개념

1) Serializer (직렬화)

Django의 `Model` 데이터를 JSON 형태로 변환하는 역할을 한다.

📌 예제: 모델을 JSON으로 변환

from rest_framework import serializers
from myapp.models import Post

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        fields = '__all__'  # 모든 필드를 포함

 

2) API View (APIView)

Django의 기본 `View`를 확장하여 API 요청을 처리하는 클래스이다.

📌 예제: APIView를 이용한 CRUD

from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from myapp.models import Post
from myapp.serializers import PostSerializer

class PostListAPIView(APIView):
    def get(self, request):
        posts = Post.objects.all()
        serializer = PostSerializer(posts, many=True)
        return Response(serializer.data)

    def post(self, request):
        serializer = PostSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

🔹 `get()` → 모든 게시글 조회
🔹 `post()` → 새로운 게시글 생성

 

3) Generic Views (DRF 제공 뷰)

반복되는 코드를 줄이기 위해 DRF에서 제공하는 Generic Views를 사용할 수 있다.

📌 예제: Generic View를 이용한 CRUD

from rest_framework import generics
from myapp.models import Post
from myapp.serializers import PostSerializer

class PostListCreateView(generics.ListCreateAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

class PostRetrieveUpdateDeleteView(generics.RetrieveUpdateDestroyAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

✅ `ListCreateAPIView` → `GET(목록 조회)`, `POST(생성)` 자동 처리
✅ `RetrieveUpdateDestroyAPIView` → `GET(단일 조회)`, `PUT(수정)`, `DELETE(삭제)` 자동 처리

 

4) ViewSet & Router

`ViewSet`은 RESTful API의 CRUD 기능을 더욱 자동화해주는 기능이다.
`Router`를 사용하면 URL 설정도 자동화할 수 있다.

📌 예제: ViewSet & Router

from rest_framework import viewsets
from myapp.models import Post
from myapp.serializers import PostSerializer

class PostViewSet(viewsets.ModelViewSet):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

 

📌 예제: Router 사용

from rest_framework.routers import DefaultRouter
from myapp.views import PostViewSet

router = DefaultRouter()
router.register(r'posts', PostViewSet)

urlpatterns = router.urls  # 자동으로 URL 생성

✅ `ModelViewSet` → CRUD 자동 처리
✅ `DefaultRouter` → `/posts/` 엔드포인트 자동 생성

---

5. 인증 & 권한 관리

DRF는 다양한 인증(Authentication) 및 권한 관리(Permissions) 시스템을 제공한다.

1) 기본 인증 설정 (`settings.py`)

REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        'rest_framework.authentication.SessionAuthentication',
        'rest_framework.authentication.TokenAuthentication',
    ],
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAuthenticated',  # 인증된 사용자만 접근 가능
    ]
}

 

2) 개별 뷰에서 권한 설정

from rest_framework.permissions import IsAuthenticated, AllowAny
from rest_framework.views import APIView

class PublicView(APIView):
    permission_classes = [AllowAny]  # 누구나 접근 가능

class PrivateView(APIView):
    permission_classes = [IsAuthenticated]  # 로그인한 사용자만 접근 가능

---

6. 페이징 & 필터링

1) 페이징 설정 (`settings.py`)

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10,  # 한 페이지에 10개씩 출력
}

 

2) 필터링 예제

from django_filters.rest_framework import DjangoFilterBackend
from rest_framework import generics
from myapp.models import Post
from myapp.serializers import PostSerializer

class PostListView(generics.ListAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer
    filter_backends = [DjangoFilterBackend]  # 필터링 활성화
    filterset_fields = ['category', 'author']  # 특정 필드로 필터링 가능

---

7. DRF 브라우저 API 인터페이스

DRF를 사용하면 웹 브라우저에서 API를 쉽게 테스트할 수 있는 GUI 인터페이스가 제공된다.

• URL에 접근하면 자동으로 API UI가 제공됨
• GET, POST, PUT, DELETE 요청을 쉽게 테스트 가능
• API 응답(JSON)도 확인 가능

---

8. DRF와 Django의 차이점

기능	Django	Django REST Framework
데이터 포맷	HTML	JSON, XML 등 다양한 포맷 지원
인증	기본 Django 인증	OAuth, JWT 등 다양한 인증 제공
API 지원 여부	수동으로 구현 필요	RESTful API 기본 지원
View 처리 방식	Django View 사용	APIView, GenericView, ViewSet 사용

---

정리 🧹

• DRF는 Django에서 RESTful API를 쉽고 강력하게 만들 수 있도록 도와줌
• Serializer를 사용하여 JSON 데이터를 다룰 수 있음
• APIView, GenericView, ViewSet을 활용하여 CRUD API를 간편하게 구현 가능
• 권한, 인증, 페이징, 필터링 기능이 기본 제공됨
• API UI 브라우저가 있어 개발 및 테스트가 용이함