[Django]REST API CRUD Server 만들기 1 - DRF

지난 포스팅에서 Django + Nginx + Gunicorn 을 연동하였으니 이제는 장고의 Rest Framework 를 이용해 간단하게 CRUD 할 수 있는

API Server를 만들어 볼 것이다. 우선 장고의 Rest Framework 에 대해 알아보자.

django-rest-framework 공식 Documentation -> www.django-rest-framework.org

 

Django REST framework

Django REST Framwork (DRF)

DRF란 Django 안에서 RESTful API 서버를 쉽게 구축할 수 있도록 도와주는 오픈소스 라이브러리(프레임워크)이다.

 

DRF 사용 이유

• 웹 브라우저 API는 범용성이 큼, 개발을 쉽게 만들어 줌
• ORM & non-ORM 에 대해 모두 Serialization 기능을 제공해줌 (DB data -> Json)
• 문서화 및 커뮤니티 지원이 잘 되어있음
• 프론트와 백엔드의 분리가 가능해짐

DRF의 개념과 사용이유에 대해서 알아보았으니 Django REST framework를 설치해볼 것이다. DRF가 지원하는 기능인 Serializer,
백엔드 & 프론트엔드 분리가 가능한 이유에 대한 설명은 과정을 진행하면서 설명할 예정이다.

 

Django REST framework 설치

(venv) $ pip install djangorestframework

지난번에 구성한 가상환경에 진입하여 가상환경 안에서 pip 명령어를 이용하여 간단하게 설치할 수 있다.

 

settings.py에 추가

# settings.py

INSTALLED_APPS = [
	... ,
    'rest_framework', # 추가
]

새로운 앱을 설치하였으니 Django 의 settings.py 의 파일안에도 명시를 해주어야 한다.

 

Model 설정하기

# app이름/models.py

from django.db import models

class User(models.Model):
    username = models.CharField(max_length=15)
    age = models.IntegerField()
    city = models.CharField(max_length=15)

API 서버를 구축하기 이전에 간단한 장고의 모델을 이용하여 데이터베이스의 테이블을 구성하였다. (default : SQLite3)

즉, 장고에서 (모델을 선언함 == 데이터베이스의 테이블) 이라고 생각하면 된다.

장고에서 지원하는 models 를 import 하고 나서 간단하게 사용자의 정보를 담을 수 있는 필드를 3가지로 정하였다.

username, city 는 문자열, 나이는 정수로 입력받을 수 있는 필드를 선언하였다.

 

migration 진행하기

# manage.py 가 있는 디렉토리에서 실행

(venv) $ python manage.py makemigrations # 모델 변경사항 감지 및 기록
(venv) $ python manage.py migrate # 변경사항을 DB에 적용

# 출력 예시
0001.... OK
0002.... OK

Django 에서는 새로운 모델을 정의하거나 수정이 이루어지면 항상 migration 이라는 작업을 거쳐야 한다.

makemigrations 는 장고 모델의 변경사항을 감지하고 기록하는 역할을 하고, migrate 는 변경사항을 실제 데이터베이스에 반영하는 역할을 한다. 따라서 모델의 생성이나 수정이 이루어지면 두 명령어를 세트로 실행해주어야 한다.

위의 명령을 실행하면 ....OK 와 같은 구문들이 여러개 출력되게 된다. 그렇다면 정상적으로 migrate 가 진행되었음을 알 수 있다.

 

다음 포스팅에서는 DRF의 viewset, Router 기능을 활용하여 실제로 동작하는 API Server 를 만들어 볼 것이다.