Django - REST framework 만들기

👩 Django REST framework를 이용해 RESTful API를 해보았다.

우선 가상환경을 설정하고 기본적인 Django 프로젝트를 생성한다.

가상환경 설정

가상환경 venv를 사용하려면 python이 3.x 버전 이상이어야 한다.
python 2.x 버전에서는 가상환경 라이브러리가 기본적으로 제공되지 않았기 때문에 virtualenv 라이브러리를 사용해야 한다.
폴더를 만들어 주고 그 폴더 안에서 python -m venv 가상환경이름 써주면 된다. dev_env 가상환경이름을 만든다.

python -m venv dev_env	//window
python3 -m venv dev_env	//mac

가상환경 활성화

폴더 안에서 가상환경이름\Scripts\activate.bat 이라고 쳐주면 가상환경이 활성화된다.

dev_env\Scripts\activate	//window
source dev_env/bin/activate	//mac

설치하기

가상환경 안에 Django, REST framework 설치한다.

(dev_env) pip install django	//Django 설치
(dev_env) pip install djangorestframework	//REST framework 설치

Django 프로젝트

장고 설치가 완료되었으면 django-admin startproject 프로젝트이름명령어로 장고 프로젝트를 시작한다. ls 명령어(윈도우 : dir)로 확인을 해보면 start_django라는 폴더가 생긴것을 확인 할 수 있다.

django-admin startproject start_django	//프로젝트 만들기

REST framework

Django REST framework를 사용하기 위해선 settings.py INSTALLED_APPS 에 ‘rest_framework’를 추가해 준다. 프로젝트 생성하면서 같이 생성한 ‘product’ 앱도 같이 추가하기😊

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'django.contrib.humanize',
    'rest_framework',
    'product',
]

Models 생성

start_django/Product/models.py 모델 생성하기

from django.db import models

# Create your models here.

class Product(models.Model):
    name = models.CharField(max_length=256, verbose_name='상품명')
    price = models.IntegerField(verbose_name='상품가격')
    description = models.TextField(verbose_name='상품설명')
    stock = models.IntegerField(verbose_name='재고')
    register_date = models.DateTimeField(auto_now_add=True, verbose_name='등록날짜')

    def __str__(self):
        return self.name

    class Meta:
        db_table = 'fast_product'
        verbose_name = '상품'
        verbose_name_plural = '상품'

Serializers 생성

REST framework 사용하기 위해서는 Serializers를 생성해야 한다.
Django를 이용한 웹 개발에서 Django ORM의 Queryset은 Django template로 넘겨지며 HTML로 렌더링 된다. 하지만 Serializers는 queryset과 모델 인스턴스와 같은 복잡한 데이터를 JSON, XML 또는 다른 콘텐츠 유형으로 쉽게 변환 할 수 있다.

# 기존 Django template
{% for product in product_list %}
        <tr>
          <th scope="row">{{ product.id }}</th>
          <th>{{ product.name }}</th>
          <th>{{ product.price|intcomma }} 원</th>
          <th>{{ product.register_date|date:'Y-m-d H:i' }}</th>
        </tr>
{% endfor %}


# JSON 데이터
{
    "id": 2,
    "name": "바나나",
    "price": 1000,
    "description": "<p>바나나입니다</p>",
    "stock": 100,
    "register_date": "2021-01-16T07:13:17.886749Z"
}

Django REST framework가 제공하는 ModelSerializer을 사용한다.
product에 serializers.py 파일을 생성한다.

# start_django/Product/serializers.py

from rest_framework import serializers
from .models import Product

class ProductSerializer(serializers.ModelSerializer):
    
    class Meta:
        model = Product
        fields = '__all__'

Views 생성

View는 실질적으로 Queryset을 컨트롤하고 데이터를 조작해 Serializer을 통해 매핑시켜 준다.

# start_django/Product/views.py

from rest_framework import generics
from rest_framework import mixins
from .models import Product
from .serializers import ProductSerializer

class ProductListAPI(generics.GenericAPIView, mixins.ListModelMixin):
    serializer_class = ProductSerializer

    def get_queryset(self):
        return Product.objects.all().order_by('id')
    
    def get(self, request, *args, **kwargs):
        return self.list(request, *args, **kwargs)


class ProductDeatilAPI(generics.GenericAPIView, mixins.RetrieveModelMixin):
    serializer_class = ProductSerializer

    def get_queryset(self):
        return Product.objects.all().order_by('id')
    
    def get(self, request, *args, **kwargs):
        return self.retrieve(request, *args, **kwargs)

마지막으로 url.py에 매핑 시켜준다.

from django.contrib import admin
from product.views import ProductListAPI, ProductDeatilAPI

urlpatterns = [
    path('admin/', admin.site.urls),
    path('api/product/', ProductListAPI.as_view()),
    path('api/product/<int:pk>/', ProductDeatilAPI.as_view())
]

실행하기

Migration 생성하고 Migrate 실행한다.
모델을 생성하고 Migration, Migrate 하고 중간에 틈틈이 확인했었다.

(dev_env) python manage.py makemigrations
(dev_env) python manage.py migrate
(dev_env) python manage.py runserver

그리고 내가 만든 주소로 확인할 수 있다.
ProductListAPI - http://127.0.0.1:8000/api/product/
ProductDeatilAPI - http://127.0.0.1:8000/api/product/2/

Django REST framework가 API 조작을 돕기 위해 기본적으로 제공해주는 페이지이다.