프로젝트 셋업

새 장고 프로젝트 tutorial을 생성하고 quickstart라는 새로운 앱을 생성하자.

# 새로운 프로젝트 디렉토리 생성
mkdir tutorial
cd tutorial

# 패키지 의존성을 로컬에서 분리하기 위해 가상환경 생성
python3 -m venv env
source env/bin/activate # 윈도우에서는 `env\\Scripts\\activate` 사용

# 가상환경에 Django와 Django REST Framework 설치
pip install django
pip install djangorestframework

# 단일의 앱으로 프로젝트 셋업
django-admin startproject tutorial .  # 점 사용시 프로젝트 폴더를 하나만 만들어줌
cd tutorial
django-admin startapp quickstart

셋업을 끝내면 아래와 같은 파일 구조가 갖춰졌을 것이다.

$ tree

├── manage.py
└── tutorial
    ├── __init__.py
    ├── __pycache__
    │   ├── __init__.cpython-39.pyc
    │   ├── settings.cpython-39.pyc
    │   ├── urls.cpython-39.pyc
    │   └── wsgi.cpython-39.pyc
    ├── asgi.py
    ├── quickstart
    │   ├── __init__.py
    │   ├── __pycache__
    │   │   ├── __init__.cpython-39.pyc
    │   │   ├── serializers.cpython-39.pyc
    │   │   └── views.cpython-39.pyc
    │   ├── admin.py
    │   ├── apps.py
    │   ├── migrations
    │   │   └── __init__.py
    │   ├── models.py
    │   ├── serializers.py
    │   ├── tests.py
    │   └── views.py
    ├── settings.py
    ├── urls.py
    └── wsgi.py

그 다음, 데이터베이스를 동기화 해준다

python manage.py migrate

admin을 위한 superuser를 생성해준다.

python manage.py createsuperuser --email [email protected] --username admin

Serializers

<aside> 💡 **Serializer**는 쿼리셋과 모델 인스턴스같은 복잡한 데이터들을 JSON, XML 형태나 다른 컨텐츠 타입으로 쉽게 렌더링 해주는 특유의 파이썬 데이터타입으로 전환시켜준다.

</aside>

from django.contrib.auth.models import User, Group
from rest_framework import serializers

class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'groups']

class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ['url', 'name']

이 예제에서는 HyperlinkedModelSerializer로 hyperlinked relation를 사용했는데, 이 방법이 RESTful한 방법이라고 한다.

Views

Viewsets를 사용함으로 로직을 간결하게 정리해줄 수 있다.

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from rest_framework import permissions
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]

class GroupViewSet(viewsets.ModelViewSet):
    queryset = Group.objects.all()
    serializer_class = GroupSerializer
    permission_classes = [permissions.IsAuthenticated]

URLs