[python][Django] DRF(장고 rest framework)와 REST API서버 개발

App application을 개발할때 우리는 REST API를 이용해 데이터를 교환한다. 

---

REST API란?

1. 일반적으로... 

 

 

서버와 클라이언트사이 데이터 교환시 우리는 HTTP프로토콜을 이용하여 데이터를 교환한다. 

 

REST API(Representational State Transper)는 HTTP를 동사는 그대로 사용하면서 더 명시적으로 Client와 Server사이의 데이터 교환을 하기위해 고안된 디자인 Guide이다. (북유럽풍, 한국식, 일본식 이런 스타일!!!)

 

2. REST 구성

• 자원(RESOURCE) - URI
• 행위(Verb) - HTTP METHOD
• 표현(Representations)

 

3. REST 특징

1) Uniform (유니폼 인터페이스)

Uniform Interface는 URI로 지정한 리소스에 대한 조작을 통일되고 한정적인 인터페이스로 수행하는 아키텍처 스타일. (유니폼한 교복같은 스타일이다)

 

2) Stateless (무상태성)

REST는 무상태성 성격을 갖는다. 다시 말해 작업을 위한 상태정보를 따로 저장하고 관리하지 않으며 이는 세션 정보나 쿠키정보를 별도로 저장하고 관리하지 않는다. 따라서 API 서버는 들어오는 요청만을 단순히 처리하면 됩니다. 때문에 서비스의 자유도가 높아지고 서버에서 불필요한 정보를 관리하지 않음으로써 구현이 단순해집니다.

 

3) Cacheable (캐시 가능)

REST는 HTTP 기존 웹표준을 그대로 사용하며, HTTP가 가진 캐싱 기능이 적용이 가능하다. 캐싱 기능은 HTTP 프로토콜 표준에서 사용하는 Last-Modified태그나 E-Tag를 이용한다ㅏ.

 

4) Self-descriptiveness (자체 표현 구조)

REST API 메시지만 보고도 이를 쉽게 이해 할 수 있는 자체 표현 구조. (그 자체만으로도 이해가 된다)

 

5) Client - Server 구조

REST 서버는 API 제공, 클라이언트는 사용자 인증이나 컨텍스트(세션, 로그인 정보)등을 직접 관리하는 구조로 각각의 역할이 확실히 구분된다.

 

6) layers (계층형 구조)

REST 서버는 다중 계층으로 구성될 수 있으며 보안, 로드 밸런싱, 암호화 계층을 추가해 구조상의 유연성을 둘 수 있고 PROXY, 게이트웨이 같은 네트워크 기반의 중간매체를 사용할 수 있다.

 

 

즉, RESTAPI는 HTTP의 동사(GET, POST, DELETE, PUT, PATCH)를 사용해 자원(URI)를 나타내는 식으로 Design하는 것을 의미한다. 

 

 

 

---

나는 서버 개발자 이다. 그리고 장고를 사용한다. 

장고에는 DRF(Django Rest Framework)를 사용하여 REST API를 개발할 수 있다.

 

일반적으로 그 개발 순서는 Model -> Serializer -> Views -> URL이다.  

 

 

조금 상세히 설명하면, Model을 이용해 Database의 ORM(Object Relational Mapping)을 설계하고, 이것을 Serialize(직렬화)한다. 그런 다음 views를 로직을 설계하고 마지막으로 url로 매핑하는 순서이다. 

 

사실 Serialize만 빼고는 장고와 DRF와 큰 차이가 없다. 

 

---

여기서 Serializer란?

객체(Object)를 일련의 데이터로 변환하는 것을 의미한다.

 

 

여기서 일련의 데이터라는 것은 Byte Stream으로 변환하는 것을 의미하며 쉽게 말해 모든 데이터 타입을 String(문자열)로 변환하는 것으로 이해해도 좋다. 

 

• 직렬화를 통해 객체의 상태를 저장하고 필요에 따라 다시 생성하여 객체의 저장소와 데이터 교환을 제공 할 수 있다.
• 보통 직렬화는 JSON이나 XML 문자열 Format을 이용하여 전달한다. 

 

 

---

Settings.py

아 그리고 DRF를 이용하려면 장고 settings.py에 몇가지 항목들을 추가해 주어야 한다.

 

Installed Apps에 rest_framework를 추가한다.

INSTALLED_APPS = [
    ...
    'rest_framework',
]

(*Installed apps에는 꼭 rest_framework를 추가해야 한다!)

 

다음과 같이 Permission이나 Authentication Class 항목들을 추가하기도 한다.  (이건 옵션)

# 예제 
REST_FRAMEWORK = {
    # Use Django's standard `django.contrib.auth` permissions,
    # or allow read-only access for unauthenticated users.
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
    ],
} 

 

 

---

DRF Overview 

그럼 REST API서버를 개발할 때 사용되는 DRF와 장고 모듈들에 대해서 한번 살펴보자.  

1. General

앞서 설명한 DRF의 기본 로직이다. 

모델은 장고 모델을 그대로 사용하고 모델을 serialize한뒤 view로 로직을 설계한다. 그런 다음 url을 매핑할때 사용되는 모듈들이다.  

 

 

Serializer는 ModelSerializer와 Serializer를 주로 사용한다.

 

views는 크게 APIViews와 VewSets으로 구분되는 것을 알 수 있다.

genericAPIView도 있는데 내부 코드를 보면 genenricAPIviews는 APIviews를 상속받아 구현하고 있다. 

 

2. Authentication, Permission

인증과 권한에 대해서 정리해 보았다. 

 

REST API에서 많이사용 되는 것은 Token방식 이기에 Token을 사용한 인증에 대해서만 정리했다. 

User모델은 장고에서 사용하는 User모델을 그대로 사용하고 DRF를 이용해서 Token을 생성하고 Serializer하고 Token을 얻는 view를 설계하는데 사용되는 모듈들을 정리해 보았다. 

 

그렇게 인증된 User, Admin 등등 User모델이 구체화 되면 Permission을 줄 수 있다. Permission역시 DRF에서 제공한다. 

 

 

아 INSTALLED_APPS에 'rest_framework.authtoken'을 추가하는 것을 잊지 말자!

 

 

---

Tutorial  

그럼 몇가지 예제를 따라해 보자. 

 

나같은 경우에는 앱안에 restapi폴더를 별도로 만들고 restapi용 serializers.py, views.py urls.py를 만들어 관리한다. 

(물론, models.py를 별도로 만들진 않는다. 모델같은 경우에는 restapi나 일반 web이나 동일하기 때문이다.)

 

폴더 구조는 다음과 같다. 

 

 

 

1. models.py

from django.db import models

class Musician(models.Model):
    first_name = models.CharField(max_length=50)
    last_name = models.CharField(max_length=50)
    instrument = models.CharField(max_length=100)

class Album(models.Model):
    artist = models.ForeignKey(Musician, on_delete=models.CASCADE)
    name = models.CharField(max_length=100)
    release_date = models.DateField()
    num_stars = models.IntegerField()

Musician과 Album 모델을 만들었다. 

 

 

2. Serializers.py 

from ..models import Album, Musician
from rest_framework.serializers import ModelSerializer                                        


class AlbumSerializer(ModelSerializer):
    class Meta:
        model = Album
        field = "__all__"


class MusicianSerializer(ModelSerializer):
    class Meta:
        model = Musician
        field = "__all__"

Album과 Musician 모델을 Serialize해 준다. ModelSerializer를 사용했다. 

 

 

3. views.py 

from .serializers import (AlbumSerializer,
                          MusicianSerializer)
from ..models import (Album,
                      Musician)

from rest_framework.viewsets import ViewSet
from rest_framework.views import APIView
from rest_framework.response import Response
from rest_framework import status
from django.http import Http404
from django.shortcuts import get_object_or_404


class AlbumView(APIView):

    def get(self, request, format=None):
        albums = Album.objects.all()
        serializer = AlbumSerializer(albums, many=True)
        return Response(serializer.data)

    def post(self, request, format=None):
        serializer = AlbumSerializer(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)


class AlbumDetailView(APIView):

    def get_object(self, pk):
        try:
            return Album.objects.get(pk=pk)
        except Album.DoesNotExist:
            raise Http404

    def get(self, request, pk, format=None):
        album = self.get_object(pk)
        serializer = AlbumSerializer(album)
        return Response(serializer.data)

    def put(self, request, pk, format=None):
        album = self.get_object(pk)
        serializer = AlbumSerializer(album, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk, format=None):
        album = self.get_object(pk)
        album.delete()
        return Response(status=status.HTTP_204_NO_CONTENT)


class MusicianViewSet(ViewSet):
    def list(self, request):
        queryset = Musician.objects.all()
        serializer = MusicianSerializer(queryset, many=True)
        return Response(serializer.data)

    def retrieve(self, request, pk=None):
        queryset = Musician.objects.all()
        musician = get_object_or_404(queryset, pk=pk)
        serializer = MusicianSerializer(musician)
        return Response(serializer.data)

views는 2가지를 이용해 보았다. 하나는 APIView와 다른 하나는 ViewSet이다. 

APIView를 이용한 CRUD는 get, put, post, delete이다. ViewSet은 좀 다른데 list, retrieve, update, particial_update, delete이다. 

 

4. urls.py

from django.urls import path
from . import views
from rest_framework.routers import SimpleRouter

router = SimpleRouter()
router.register(r'musician', views.MusicianViewSet, basename='musician')
urlpatterns = router.urls


urlpatterns += [
    path('albums/', views.AlbumView.as_view()),
    path('albums/<int:pk>/', views.AlbumDetailView.as_view()),
]

APIView와 ViewSet의 라우팅방법역시 조금 다르다. 

APIView는 path함수를 이용해서 url과 view를 연결하고 ViewSet은 Router 인스턴스의 register 메소드를 사용해서 url을 연결한다. 

 

[출처] https://breakout-theworld.tistory.com/23