Request를 HTTP 프로토콜로 하고 response는 JSON 형태로! Serializer와 API view가 필요하다.
3. 그래서 어떻게 모바일 백엔드를..?
백엔드 개발 순서가 따로 있는건 아니지만 추천을 한다면 먼저 모델을 개발하고(models.py), 그 다음에 seralizer.py, urls.py, views.py 순서로 하면 좋은 것 같다.
django-admin startapp (앱 이름) 명령어를 통해 앱을 생성하자. 모델은 원래 유저를 써보자.
메인 프로젝트 이름있는 폴더 안에서 seralizer.py를 생성하자.
(1) serializer.py 생성
#(앱이름)/serializer.py
from rest_framework import serializers
from django.contrib.auth.models import User
class UserSerializer(serializer.ModelSerializer):
class Meta:
model = User
fields = ('url', 'username', 'email')
원래 있던 유저의 정보를 serailize 하는 것이다!
필드는 직접 설정할 수도 있고, 모든 필드를 불러오고 싶다면fields = '__all__' 로 하면 된다.
(2) urls.py를 설정하자
#(프로젝트폴더이름)/urls.py
from django.urls import path
from user.views import fetch_user
urlpatterns = [
...
path('fetch_user/', fetch_user),
]
(3) views.py를 작성하자 (젤 중요!!)
#(앱이름)/views.py
from django.contrib.auth.models import User
from rest_framework.decorators import api_view
from .serializer import UserSerializer
from rest_framework.response import Response
@api_view(['get'])
def fetch_user(request):
#fetch all user objects
users = User.objects.all()
serializer = UserSerializer(users, many=True)
#return Response using rest_framework's response
return Response(seralizer.data)
유저 정보를 받아오는 fetch_user 함수를 작성한 모습이다.
request가 들어오면 리턴하는 형식이다. 이 예시는 GET만 허용한다. (POST 안됨)
위의 serializer.py에서 만든 UesrSerializer를 통해 직렬화를 하고, many=True를 통해 잠재적으로 둘 이상의 객체가 있음을 알린다. api_view는 장고 rest 프레임 워크에서 제공하는 것으로, 이쁘게 보여주는 화면같은거다.
REST 프레임워크에서 Response를 import해와서 JSON 형식으로 응답하도록 했다.
응답은 serializer.data로 모든 유저 객체 정보를 보여주도록 설정했다.
(4) 실행시켜보자
python manage.py runserver를 터미널에서 실행시키고 웹브라우저로 http://localhost:8000/fetch_user 를 들어가면!
이렇게 에러가 뜬다 ㅎㅎ views.py의 serializer 부분을 아래와 같이 수정하자.
이 전에 포스팅에도 나와있는데, serialize를 한다는 것은JSON이나 XML 파일 등으로 바꾸어 주는 것을 말한다.
tutorial/quickstart/serializers.py 를 생성해 아래의 코드 내용을 넣자.
#tutorial/quickstart/serializers.py
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를 사용했는데, 다른 것들도 다 사용할 수 있다.
근데 hyperlink를하는게 좋은 RESTful 디자인이라고 한다.
3. Views.py 작성
그 다음엔 뷰를 작성해보도록 하자.
# tutorial/quickstart/views.py
from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.quickstart.serializers import UserSerializer, GroupSerializer
class UserViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows users to be viewed or edited.
"""
queryset = User.objects.all().order_by('-date_joined')
serializer_class = UserSerializer
class GroupViewSet(viewsets.ModelViewSet):
"""
API endpoint that allows groups to be viewed or edited.
"""
queryset = Group.objects.all()
serializer_class = GroupSerializer
ViewSet을 사용해서 편하게 작성할 수 있다.
(django rest framework가 제공해줌. 예쁘기도 하고 편하기도 하다.)
4. urls.py 작성하기
사실 혼자서 따라할때 여기가 자꾸 어디 urls.py인지 헷갈렸다.. tutorial/tutorial/urls.py 에 작성해야한다.
# tutorial/tutorial/urls.py
from django.contrib import admin
from django.urls import include, path
from rest_framework import routers
from quickstart import views #이 부분 수정함
router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)
# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
path('', include(router.urls)),
path('api-auth/', include('rest_framework.urls', namespace='rest_framework')),
path('admin/', admin.site.urls),
]
우리는 위에서 view 대신에 viewset을 사용해서 자동적으로 URLconf를 우리의 API에 생성할 수 있다.
그래서 그냥 라우터 클래스에 등록해주기만 하면 끝!
또, API URL들을 기본 제공하는 기능보다 더 추가하고싶다면 URL conf를 명시해주면 된다.
마지막으로, 로그인 로그아웃 디폴트를 추가해주었는데, 선택 사항이지만 매우 유용해서 추가했다. 굳~
5. settings.py 손보기
tutorial/tutorial/settings,.py 의 파일을 손보자. 아래의 코드 내용을 settings.py에 붙여넣어준다.
어떤 특정한 것을 개발하는 중에 발생했던 문제점들을 정리해서 상황에 따라 간편하게 적용해서 쓸 수 있는 것을 정리하여 특정한 '규약'을 통해 쉽게 쓸 수 있는 형태로 만든 것을 말한다.
라이브러리나 프레임워크가 그에 따른 예. 결국 좀 더 쉽고 편리하게 사용할 수 있게 만든 특정한 방법을 뜻함.
MVC design pattern
하나의 어플리케이션, 프로젝트를 구성할 때 그 구성요소를 세 가지 역할(model, view, controller)로 구분한 패턴이다.
이 패턴을 사용하면 사용자 인터페이스로부터 비즈니스 로직을 분리하여 어플리케이션의 시각적인 요소나 그 이면에서 실행되는 비즈니스 로직을 서로 영향 없이 쉽게 고칠 수 있는 어플리케이션을 만들 수 있다.
Model : 어플리케이션의 정보(데이터)를 나타냄
View : 텍스트, 체크박스 항목 등과 같은 사용자 인터페이스 요소를 나타냄
Controller : 데이터와 비즈니스 로직 사이의 상호 동작을 관리함.
1. 모델, Model
어떤 동작을 수행하는 코드를 말한다. 사용자에게 어떻게 보일지 신경 쓰지 않아도 되는 모델은 순수 public 함수로만 이루어진다. 몇몇 함수들은 사용자의 질의(query)에 대해 상태 정보를 제공하고 나머지 함수들은 상태를 수정한다.
모델은 모델의 상태에 변화가 있을 때 컨트롤러와 뷰에 이를 통보해야한다. 이와 같은 통보를 통해 뷰는 최신의 결과를 보여줄 수 있고, 컨트롤러는 모델의 변화에 따른 적용 가능한 명령을 추가/제거/수정할 수 있다.
2. 뷰, View
데이터 및 객체의 입력, 그리고 보여주는 출력을 담당함.데이터를 기반으로 사용자들이 볼 수 있는 화면이다.
뷰는 사용자가 볼 결과물을 생성하기 위해 모델로부터 정보를 읽어온다. 뷰는 모델이 가지고 있는 정보를 따로 저장해서는 안된다. 단지 읽어오기만 해야할 뿐! 변경이 일어나면 변경 통지에 대한 처리 방법을 구현해야 한다.
3. 컨트롤러, Controller
데이터와 사용자 인터페이스 요소들을 잇는 다리 역할을 한다. 즉, 사용자가 데이터를 출력하고 수정하는 것에 대한 '이벤트'들을 처리하는 부분을 뜻한다.
컨트롤러를 사용하여 모델의 상태를 바꾼다. 이 때 모델의 상태가 바뀌면 등록된 뷰에 자신의 상태가 바뀌었다는 것을 알리고 뷰는 거기에 맞게 사용자에게 모델의 상태를 보여준다.
왜 MVC 패턴을 사용해야 할까?
사용자가 보는 페이지, 데이터 처리 그리고 이 두가지를 중간에서 제어하는 컨트롤러 이 세 가지로 구성되는 하나의 어플리케이션을 만들면 각각 맡은 바에만 집중할 수 있게 된다. 서로 분리되어 각자의 역할에 집중할 수 있게끔 하여 개발을 하고 그렇게 어플리케이션을 만든다면 유지보수성, 확장성, 유연성 등이 증가하고 중복 코딩이라는 문제점 또한 사라진다.
먼저 REST에 대해서 소개를 하자면, http의 url과 http method(GET, POST, PUT, DELETE)를 사용해서 API 가독성을 높인 구조화된 시스템 아키텍쳐(framework)라고 생각하면 된다.
하나의 URL로 우리는 최소 4가지의 HTTP method를 전송할 수 있다.
스마트폰이 등장하기 전 IT 기업들은 웹 페이지를 보여주는 웹서버만 구현하면 됬다.
그 웹 서버에서 DB 서버의 데이터도 읽어오고 사용자들이 글을 남기면 DB 서버에 저장까지 하는 기능을 모두 담당했다. 하지만 스마트폰이 출시되고, 어플리케이션의 등장으로 더이상 웹으로만 서비스를 제공하는 것에는 한계가 있었다.
따라서 HTML로 렌더링 하는 웹서버가 아닌, JSON 혹은 XML 과 같은 형식을 통해서 데이터를 다루는 별도의 API 서버가 필요했다. 스마트폰 어플과 웹에서 동일한 기능을 제공하는데 기존의 웹서버를 계속 사용하면 매번 HTML을 읽어서 해당 태그에 있는 정보를 찾아내는 일은 정말미친짓이기 때문이다. (덜덜)
따라서 RESTful 아키텍쳐를 HTTP Method와 함께 사용해 웹, 데스크탑 앱, 스마트폰 어플들까지 하나의 API 서버를 생성할 수 있다.
Django 또한 View 클래스 자체가 RESTful 한 서버를 만들기에 최적인 프레임워크다.
장고 REST 프레임워크는 웹 API를 구축하기 위한 강력하고 유연한 툴킷입니다.
DRF(Django Rest Framework)란
Django 안에서 RESTful API 서버를 쉽게 구축할 수 있도록 도와주는 오픈소스 라이브러리다.
Django REST framework를 사용하는 이유는 아래와 같다.
웹 브라우저 API는 범용성이 크다. 개발을 쉽게 만들어준다.
인증 정책에 OAuth1, OAuth2 를 위한 추가적인 패키지가 추가되어 있는 경우
시리얼라이즈 기능을 제공해준다. (DB data -> JSON)
문서화 및 커뮤니티 지원이 잘 되어있다.
Serializer 란
DRF의 가장 매력적인 기능으로는 Serializer가 있다.
Serializer란 말 그대로 직렬화하는 클래스로서, 사용자의 DB안에 사용자 프로필 사진, 이메일, 이름, 성별이 있다고 가정하면 사용자 모델 인스턴스를 JSON 형태 혹은 Dictionary 형태로 직렬화 할 수 있다.
위와 같은 사용자가 있다면 DRF의 serializer를 통해 모델 인스턴스를 직렬화 할 수 있다.
실 사용시에는 만약 사용자 정보를 열람하는 URL이 /serializer/user/<user id>/가 있고 해당 View에는 user_id의 해당하는 모델 인스턴스의 정보를 리턴한다고 가정하자. 그렇게 되면 만약 우리가 /serializer/user/1/ 이라는 URL로 요청했을 시 user_id가 1인 사용자의 정보를 JSON 형태로 응답받을 수 있다.
이는 사용자 프로필 페이지에 접근했을 때 사용하는 View 라고 하면 사용자 페이지에 들어갈 때 마다 해당하는 사용자의 user_id만 URL에 입력해주게되면 각 사용자의 정보를 JSON 형태로 응답 받을 수 있을 것이다.
위와 같은 기능을 하는 Serializer를 ModelSerializer라고 부른다.
Django REST Framework 설치
pip install djangorestframework
위의 명령어를 터미널에서 실행시키자.
다음으로는 django settings.py 파일에서 INSTALL_APP 부분에 'rest_framework' 를 명시해주자.
