Chapter5 연습 프로젝트 : Todo 목록 API 만들기

5.1 Todo 목록 API 시작하기

5.2 Todo 전체 조회 API 만들기

5.3 Todo 상세 조회 API 만들기

5.4 Todo 생성 API 만들기

5.5 Todo 수정 API 만들기

5.6 Todo 완료 API 만들기

 

5.1 Todo 목록 API 시작하기

DRF를 활용해 본격적으로 개발할 프로젝트는 Todo 목록 서비스 입니다. 

 

5.1.1 Django 기반 Todo 목록 웹 서비스 복습

우리가 앞전에 했던 Todo 서비스는 완료되지 않은 Todo와 완료된 것을 나눠서 목록으로 볼 수 있었고, Todo에 대한 목록 및 상세 조회가 가능했습니다. 당연히 수정 기능도 있었고, Todo를 완료시키는 기능도 제공하였습니다. 

이제 우리는 Todo 서비스를 프론트 영역과 분리시켜,

API의 형태로 개발하려고 합니다. ⭐️

 

5.1.2 프로젝트 생성하기

가상환경 세팅

django-admin startproject mytodo .

 

5.1.4 Todo 모델 생성하기

모델은 앞서 개발한 Todo 서비스와 동일합니다. 

개발되는 형태만 달라졌을 뿐, 다루는 데이터는 동일하기 때문에 우리는 앞서 작성한 모델을 그대로 가져다 쓸 수 있습니다.

 

 

5.2 Todo 전체 조회 API 만들기

Todo 전체 조회 기능을 개발해 보겠습니다. 

 

5.2.1 Todo 전체 조회 시리얼라이저 만들기

DRF 개발의 첫 단계는?

-> 시리얼라이저 개발입니다.

시리얼라이저는 앞에서 봣던 것 처럼, 

데이터를 원하는 형태로 보내고, 받기 위한 일종의 양식입니다. 

 

따라서 보내고 받는 형태에 따라 다른 시리얼라이저가 필요 합니다. 

 

첫 번째로 개발할 시리얼라이저는 전체 조회용 시리얼라이저인데, 

 

전체 조회에서는 Todo 설명을 제외한

제목, 완료 여부, 중요 여부가 필요하기 때문에

이들만을 포함한 간단한 시리얼라이저를 만들겠습니다. 

 

serializers.ModelSerializer를 활용해(매개변수로)

간단히 시리얼라이저를 완성했으며, 

TodoSimpleSerializer라고 이름 붙였습니다. 

TodoSimpleSerializer는 Todo 모델의 id, title, complete, important 필드를 직렬화하고 역직렬화하는 기능을 제공합니다. 이를 통해 Todo 모델의 인스턴스를 JSON 형식으로 변환하거나 JSON 데이터를 Todo 모델의 인스턴스로 변환할 수 있습니다.

 

Todo 전체 조회 뷰 만들기

다음은 뷰 입니다. 이번 프로젝트에서는 Todo 완료 및 조회 기능이 포함되어 있기 때문에

ViewSet보단 APIView를 활용해 한땀 한땀

직접 개발하는 방식으로 진행하겠습니다. 

전체 조회 뷰는 GET방식으로 요청을 처리합니다.

 

따라서 TodosAPIView라는 클래스를 만들고

내부의 get 메소드에서 complete이 False인 Todo들을 필터링하도록 합니다. 

 

이후 시리얼라이저를 통과시켜 보낼 수 있는 형태로 변환한 다음,

이를 Response 객체 형태로 전달하는 과정으로 작성할 수 있습니다. 

이 코드는 할 일 목록을 가져오는 단순한 API 뷰를 정의하고 있습니다. 클라이언트가 해당 API 엔드포인트로 GET 요청을 보내면 미완료된 할 일들의 목록을 JSON 형식으로 반환합니다.

 

 

5.2.3 Todo 전체 조회 URL 연결하기 

이제 URL만 연결하면 놀랍게도 구현이 완료됩니다. 

TodosAPIView 클래스는 todo/에 주소를 할당하겠습니다.

이후 개발할 다른 메소드도 해당 주소를 사용하게 됩니다. 

 

 

5.2.4 Todo 전체 조회 API 테스트하기 

 

관리자 페이지에 들어가 미리 Todo를 추가해놓습니다. 

대략 위와 같은 형태로 추가하면 됩니다. 

-> 책에 없는 부분... 하ㅏㅏㅏㅏ

-> 빼먹으면 404에러가 나니 주의

 

앞서 사용했던 Insomnia 도구를 켜서 API 테스트를 진행하겠습니다. 

GET요청으로 127.0.0.1:8000/todo/에 요청을 보내겠습니다. 

 

5.3 Todo 상세 조회 API만들기

Todo 상세 조회 기능을 개발해 보겠습니다.

 

5.3.1 상세 조회용 Todo 시리얼라이저 만들기

이번에는 Todo 상세 조회용 시리얼라이저 입니다. 

앞서 개발한 시리얼라이저가 TodoSimpleSerializer였으니

이번에는 TodoDetailSerializer라는 이름으로 개발하겠습니다. 

필드는 Todo 모델의 모든 필드로 설정하면 되겠습니다. 

 

5.3.2 Todo 상세 조회 뷰 만들기

상세 조회 뷰 역시 GET방식으로 통신합니다. 

전체 조회(TodoAPIView)와는 주소가 다르기 때문에 클래스를 구분해야합니다.

 

기본적으로 클래스를 기준으로 URL을 분리한다고 생각하면 편합니다. 

: 같은 클래스 -> 같은 URL

get_object_or_404() 함수는 주어진 모델(Todo)에서 주어진 조건(id=pk)에 해당하는 객체를 가져오는데, 해당 객체가 존재하지 않을 경우 404 예외를 발생시킵니다. 따라서 이 코드는 pk에 해당하는 Todo 객체를 가져옵니다.

TodoDetailSerializer는 todo 객체를 직렬화하기 위한 시리얼라이저입니다. 시리얼라이저는 Python 객체를 JSON 등의 형식으로 변환하거나, 반대로 JSON 등의 형식을 Python 객체로 변환하는 역할을 합니다. serializer.data는 todo 객체를 직렬화한 결과를 나타냅니다.

 

5.3.3 Todo 상세 조회 URL 연결하기

TodoAPIView는 특정 Todo의 id를 기반으로 구분되므로 -> PK

todo// 주소에 TodoAPIVIEW를 할당하겠습니다. 

 

5.3.4 Todo 상세 조회 API 테스트 하기

이번에도 GET요청을 보내겠습니다.

 

 

5.4 Todo 생성 API 만들기

Todo 생성 API를 개발해보겠습니다.

 

5.4.1 생성용 Todo 시리얼라이저 만들기

Todo 생성에 필요한 입력 값은 title과 description, important 뿐입니다.

나머지 필드는 자동으로 채워지기 때문입니다. 

TodoCreateSerializer에는 3개의 필드만 작성해놓으면 됩니다. 

 

 

5.4.2 Todo 생성 뷰 만들기

Todo 생성은 /todo URL에서 동작할 것입니다. 

특정 Todo 의 id가 필요없는 작업이기 때문입니다. 

 

따라서 Todo 생성 뷰는 TodosAPIView 클래스 내에 포함될 수 있습니다. 

Todo 생성은 POST 방식으로 통신하도록 작성할 수 있습니다.

from rest_framework import status
from rest_framework.generics import get_object_or_404
from rest_framework.response import Response
from rest_framework.views import APIView

from rest_framework import viewsets

from .models import Todo
from .serializers import TodoSimpleSerializer, TodoDetailSerializer, TodoCreateSerializer


class TodosAPIView(APIView):
    def get(self, request):
        todos = Todo.objects.filter(complete=False)
        serializer = TodoSimpleSerializer(todos, many=True)
        return Response(serializer.data, status=status.HTTP_200_OK)

    def post(self, request):
        serializer = TodoCreateSerializer(data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

 

 

5.4.3 Todo 생성 URL 연결하기

앞서 TodosAPIView에 대한 URL을 할당했기 때문에 별도의 작업은 필요 없습니다.

-> 그대로 

 

 

5.4.4 Todo 생성 API 테스트하기 

생성 API 테스트를 위해 POST 요청으로 127.0.0.1:8000/todo/에 요청을 보내며,

Body에는 JSON 형태로 값을 채워넣었습니다.

우리는 title, description 그리고 필요에 따라 important만 넣으면 됩니다. 

 

생성이 잘 되었는지 전체 조회 API로 확인해보면 전체 조회가 잘 되는 것을 확인할 수 있습니다.

 

 

5.5 Todo 수정 API 만들기 

 

Todo 수정 API를 개발해보겠습니다. 

 

5.5.1 Todo 수정 뷰 만들기

Todo 수정 API는 앞서 작성한 Todo 생성과 거의 동일합니다. 

동일한 필드를 다루기 때문에 시리얼라이저도 따로 작성할 필요 없이 TodoCreateSerializer를 활용할 수 있습니다. 

그리고 Todo 수정은 특정 Todo에 대해 이뤄지므로 TodoAPIView 클래스에 포함시키면 되겠습니다. 

from rest_framework import status
from rest_framework.generics import get_object_or_404
from rest_framework.response import Response
from rest_framework.views import APIView

from rest_framework import viewsets

from .models import Todo
from .serializers import TodoSimpleSerializer, TodoDetailSerializer, TodoCreateSerializer

class TodoAPIView(APIView):
    def get(self, request, pk):
        todo = get_object_or_404(Todo, id=pk)
        serializer = TodoDetailSerializer(todo)
        return Response(serializer.data, status=status.HTTP_200_OK)

    def put(self, request, pk):
        todo = get_object_or_404(Todo, id=pk)
        serializer = TodoCreateSerializer(todo, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=status.HTTP_200_OK)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

수정 기능은 put 메소드 형태로 작성할 수 있습니다. 

특정 Todo를 찾아서 요청으로 전달받은 데이터를 시리얼라이저에 통과시켜 저장하는 방식

 

 

5.5.2 Todo 수정 URL 연결하기

역시 TodoAPIView는 이미 URL에 연결되어 있으므로 추가적인 연결작업은 필요 없습니다. 

-> 이전 코드와 동일

 

 

5.5.3 Todo 수정 API 테스트하기 

수정하여 요청을 보내놉니다. 

수정이 잘 된것을 확인할 수 있습니다.

 

5.6 Todo 완료 API 만들기

 

마지막으로 Todo 완료 API를 개발해보겠습니다. 

 

5.6.1 Todo 완료 뷰 만들기

Todo 완료 기능만 개발하면 Todo 프로젝트도 마무리 됩니다. 

Todo 완료 API는 별도의 클래스에 작성할 것 이며, 

 

역시 완료 목록 조회용 API와

특정 Todo 완료 API가 필요합니다. 

 

각 API는 Todo id 필요 여부에 따라 주소가 다르기 때문에 조금 번거롭지만 각각 하나의 클래스로 작성해야 합니다. 

다음은 완료 Todo목록 조회용 API입니다.

이 코드는 GET 요청을 받으면 완료된 할 일 객체들을 직렬화하여 클라이언트에게 JSON 형식의 응답으로 반환합니다. 응답은 HTTP 상태 코드 200(성공)과 함께 전송됩니다.

 

 

 

5.6.2 Todo 완료 조회 뷰 만들기

다음은 Todo 완료 API의 뷰 입니다.

 

5.6.3 Todo 완료 URL 연결하기 

 

5.6.4 Todo 완료 API 테스트 하기 

요청을 보내면 기존에 있던 Done 목록이 나타나는 것을 볼 수 있습니다. 

 

 

chapter5 마칩니다.