REST API 참고 링크 1
REST API 참고 링크 2
REST는 Representational State Transfer라는 용어의 약자로, 소프트웨어 아키텍쳐의 한 형식이다.
REST API는 자원-URI / 행위-HTTP METHOD / 표현 으로 구성되어 있다.
즉 URI는 정보의 자원을 표현하고, 그에 대한 행위는 HTTP Method(GET, POST, PUT, DELETE)로 표현한다.
예를 들어, GET /members/delete/1 은 REST를 제대로 적용하지 않은 URI다. URI는 자원을 표현하는데 중점을 두어야 하므로 delete와 같은 행위에 대한 표현이 들어가서는 안 된다. 이는 DELETE /members/1 로 수정할 수 있다.
djangorestframework 패키지를 설치한다. 가상환경에서 설치했을 때 자꾸 오류 떠서 구글링하다가 local에도 설치하라는 거 보고 냅다 했더니 해결
설치가 끝났으면 settings.py를 수정해 줘야 한다.
INSTALLED_APPS = [
'django.contrib.admin',
'django.contrib.auth',
'django.contrib.contenttypes',
'django.contrib.sessions',
'django.contrib.messages',
'django.contrib.staticfiles',
'account', # 웹앱 추가
'rest_framework' # 프레임워크 추가
]
REST_FRAMEWORK = { # 권한 설정
'DEFAULT_PERMISSION_CLASSES': [
'rest_framework.permissions.DjangoModelPermissionsOrAnonReadOnly'
]
}
from django.db import models
class Account(models.Model):
name = models.CharField(max_length = 50)
email = models.CharField(max_length = 200)
password = models.CharField(max_length = 200)
created_at = models.DateTimeField(auto_now_add=True)
Account 모델에 회원 데이터를 정의한다. DB의 table을 만드는 부분
from rest_framework import serializers
from .models import Account
class AccountSerializer(serializers.ModelSerializer):
class Meta:
model = Account
fields = ['id', 'name', 'email', 'password']
Account 모델로 만든 데이터를 json 형태로 변환해 주는 것이 AccountSerializer가 된다. rest framework에서 쓸 수 있는 기능으로, 웹프로젝트 디렉토리에 직접 .py 파일을 만들어 줘야 한다. (id는 pk로 쓰이는 자동 생성 필드)
from django.http import HttpResponse, JsonResponse
from django.views.decorators.csrf import csrf_exempt
from .models import Account
from .serializers import AccountSerializer
from rest_framework.parsers import JSONParser
@csrf_exempt
def account_list(request):
if request.method == 'GET':
query_set = Account.objects.all()
serializer = AccountSerializer(query_set, many=True)
return JsonResponse(serializer.data, safe=False)
elif request.method == 'POST':
data = JSONParser().parse(request)
serializer = AccountSerializer(data=data)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data, status=201)
return JsonResponse(serializer.errors, status=400)
@csrf_exempt
def account(request, pk):
obj = Account.objects.get(pk=pk)
if request.method == 'GET':
serializer = AccountSerializer(obj)
return JsonResponse(serializer.data, safe=False)
elif request.method == 'PUT':
data = JSONParser().parse(request)
serializer = AccountSerializer(obj, data=data)
if serializer.is_valid():
serializer.save()
return JsonResponse(serializer.data, status=201)
return JsonResponse(serializer.errors, status=400)
elif request.method == 'DELETE':
obj.delete()
return HttpResponse(status=204)
@csrf_exempt
def login(request):
if request.method == 'POST':
data = JSONParser().parse(request)
search_email = data['email']
obj = Account.objects.get(email=search_email)
if data['password'] == obj.password:
return HttpResponse(status=200)
else:
return HttpResponse(status=400)
from django.urls import path
from account import views
from django.conf.urls import include
urlpatterns = [
path('accounts', views.account_list),
path('accounts/<int:pk>', views.account),
path('login', views.login),
path('auth', include('rest_framework.urls', namespace='rest_framework'))
]