Django REST Framework 강의 내용정리(0~2강)

# 0. Blog 프로젝트 미리보기

 

url VS DRF url

rest 방식은 url에 동작을 표현하지 않고 method에서 표현한다!!

REST는  url 끝에 / 를 붙이지 않는걸 권장하지만 Django에서는 붙이는걸 권장하기 때문에 /를 붙인다...

 

# 1. DRF Example 따라하기

 

- 가상환경 만들기(python -m venv venv)

 

- router / viewset 코딩하기

 

1. 레스트 프레임워크 설치하기 : pip install djangorestframework 설치하기 밑에 두개 안해도 된다!!!

 

2. restframework settings.py에 등록하기

 

3. urls.py에 rest_framwork.urls 경로 넣어주기(auth관련 기능을 한다)

4. settings.py 제일 밑에 추가해준다, Django REST Framework 설정 중 기본 권한 클래스를 지정하는 부

 

5. urls.py 이걸로 덮어쓰기!!!

 

DRF 첫화면이 제대로 나왔으면 성공!!!

 

- DRF Browsable API

 

api로 받는 버전 / default는 api이다...

 

json으로 받는 버전

DRF default mode

1) browser : api

2) client : json

 

브라우저가 아니라 다른 client라함은... curl / httppie / postman / vue.js / react.js...등이 있다

공식문서에서는 api mode == browsable api 라고 사용하고 있다!!!

 

- 인증 기능 오버뷰

# DRF
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'
    ]
}

settings.py 마지막에 넣은 이 코드의 의미...
로그인한 사용자에 대해서는 crud가 가능 권한이 없는 유저에 대하서는 r만 가능하다...
없다면 모든 사용자에 대해서 crud가 가능해진다..

 

- DRF 주요 사항

 

/users/  : C, R(list)

/users/pk/ : U, D, R(detail)

 

/api/users/ : prefix : appName, api

 

# 2. DRF API 만들기

 

- url / view / serializer 구조 잡기 (s, M, u, V 순으로 코딩 settings / Model / url / View)

 urls.py에 덮어쓴것 새로 만든 api2 앱의 urls.py / views.py / serializers.py에 적절히 할당해주기

 

- DRF Router

 

DefaultRouter(7개) vs SimpleRouter(2개)

 

users/ GET(list)

users/ POST(create)

 

users/pk/GET(retrieve)

users/pk/PUT(update)

users/pk/DELETE(destroy)

users/pk/PATCH(partial_update)

 

=======

DefaultRouter에만 있는것들

API Root(api2/)

format suffix(users.json, users.api)

                   (users/99.json, users/99.api)

 

ex) users.api, users.json(접미사로 표현 가능)

 

- viewset 문서 확인

class UserViewSet(viewsets.ModelViewSet):
    queryset = User.objects.all()
    serializer_class = UserSerializer
    
ModelViewSet을 상속 받아 메인 기능들을 다 구현할 수 있다!!!

 

https://www.cdrf.co/

Django REST Framework 3.14 -- Classy DRF

Create => CreateAPIView(POST)

Read => ListAPIView(GET)

          => RetrieveAPIView(GET)

Update => UpdateVPIView(UPDATE, PATCH)

Delete => DestroyAPIView(DELETE)

 

- blog API 시작하기

 

/api/post/list/ (GET) => /api2/post/ (GET)

/api/post/99/ (GET) => /api2/post/99/ (GET)

 

/api/comment/create/(POST) => /api2/comment/(POST)

 

/api/like/99/(GET) => 

 

/api/catetag/(GET) =>

 

api2에 이 기능들을 DRF로 만들 예정임..(like와 catetag는 나중에 보기로

 

- viewset으로 POST API 만들기

 

# serializers.py 

class PostSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        # fields = '__all__'
        fields = ['id', 'title', 'image', 'like', 'category']
        
# urls.py
router.register(r'post', PostViewSet)

#views.py
class PostViewSet(viewsets.ModelViewSet):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

 

- viewset으로 Comment API 만들기

 

위 방법과 동일!!!

 

- viewSet vs Generic Views(이 친구의 예들)

 

ListAPIView,CreateAPIView

RetrieveAPIView, UpdateAPIView, DestroyAPIView

 

/appi2/post/ (GET) --> ListAPIView

/api2/post/99/(GET) --> RetrieveAPIView

/api2/comment/(POST) --> CreateAPIView

 

# urls.py 갱신하기
from django.urls import path
from api2 import views

urlpatterns = [
    path('post/', views.PostListAPIView.as_view(), name='post-list'),
    path('post/<int:pk>/', views.PostRetrieveAPIView.as_view(), name='post-detail'),
    path('comment/', views.CommentCreateAPIView.as_view(), name='comment-list'),

]

 

- xxxAPIView 외 ModelSerializer

 

# views.py 갱신

from rest_framework.generics import ListAPIView, RetrieveAPIView, CreateAPIView
from api2.serializers import CommentSerializer, PostSerializer

from blog.models import Comment, Post

class PostListAPIView(ListAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer

class PostRetrieveAPIView(RetrieveAPIView):
    queryset = Post.objects.all()
    serializer_class = PostSerializer
    

class CommentCreateAPIView(CreateAPIView):
    queryset = Comment.objects.all()
    serializer_class = CommentSerializer

 

Generic View

 

1) data from db

2) serialize

* ListAPIView => POSTSerializer(instance=, many=True)

* RetrieveAPIView => POSTSerializer(intstance=, many=False)

3) response

 

- xxxAPIView 소스 구조

 

# views.py
from rest_framework.generics import ListAPIView, RetrieveAPIView, CreateAPIView
from api2.serializers import CommentSerializer, PostListSerializer, PostRetrieveSerializer

from blog.models import Comment, Post

class PostListAPIView(ListAPIView):
    queryset = Post.objects.all()
    serializer_class = PostListSerializer

class PostRetrieveAPIView(RetrieveAPIView):
    queryset = Post.objects.all()
    serializer_class = PostRetrieveSerializer
    

class CommentCreateAPIView(CreateAPIView):
    queryset = Comment.objects.all()
    serializer_class = CommentSerializer
    

# serializers.py
from django.contrib.auth.models import User
from rest_framework import serializers

from blog.models import Comment, Post

# Serializers define the API representation.
class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'is_staff']

class PostListSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        # fields = '__all__'
        fields = ['id', 'title', 'image', 'like', 'category']

class PostRetrieveSerializer(serializers.ModelSerializer):
    class Meta:
        model = Post
        # fields = '__all__'
        exclude = ['create_dt']

class CommentSerializer(serializers.ModelSerializer):
    class Meta:
        model = Comment
        fields = '__all__'
        # fields = ['id', 'title', 'image', 'like', 'category']

 

partial = True

Post(update)

특정 속성에 대한 update 가능...

 

PUT vs PATCH

UpdateAPIView (not PatchAPIView)