Django REST Framework 시작하기

Django REST Framework(DRF)는 Django를 이용해 API를 설계하고 구현하는 강력한 도구입니다. 이를 통해 JSON 형식으로 데이터를 반환하는 API를 쉽게 개발할 수 있습니다. 아래에서는 DRF를 활용해 간단한 API를 만들어보는 과정을 단계별로 설명합니다.

DRF 설치 및 설정

1. DRF 설치:

   pip install djangorestframework
   

2. 설정: settings.py에 rest_framework를 추가합니다:

   INSTALLED_APPS = [
       ...
       'rest_framework',
       ...
   ]
   

URL 구성

API를 위한 URL 경로를 설정합니다. urls.py 파일:

from django.urls import path
from . import views

app_name = "articles"
urlpatterns = [
    path("html/", views.article_list_html, name="article_list_html"),
    path("json-01/", views.json_01, name="json_01"),
    path("json-02/", views.json_02, name="json_02"),
    path("json-drf/", views.json_drf, name="json_drf"),
]

Serializer 생성

Serializer는 데이터를 직렬화하여 JSON으로 변환합니다. serializers.py 파일:

from rest_framework import serializers
from .models import Article

class ArticleSerializer(serializers.ModelSerializer):
    class Meta:
        model = Article
        fields = "__all__"

View 구성

views.py 파일:

from rest_framework.decorators import api_view
from rest_framework.response import Response
from .serializers import ArticleSerializer

@api_view(["GET"])
def json_drf(request):
    articles = Article.objects.all()
    serializer = ArticleSerializer(articles, many=True)
    return Response(serializer.data)

DRF API 테스트

간단한 Python 프로그램으로 API를 호출하여 테스트할 수 있습니다. my_program.py 파일:

import requests

url = "http://127.0.0.1:8000/api/v1/articles/json-drf"
response = requests.get(url)

print(response)
print(response.json())

위 코드를 실행하면 서버에서 반환한 JSON 데이터를 확인할 수 있습니다.

02. Postman

Postman이란?

Postman은 API를 디자인, 테스트, 문서화, 공유할 수 있는 강력한 도구입니다. 이를 통해 API 호출 및 결과 확인이 가능하며, 개발 중 API의 테스트를 간편하게 수행할 수 있습니다.

Postman 시작하기

1. Postman 공식 사이트에서 가입 및 설치를 진행합니다.

2. 주요 기능:

   • API 호출 테스트
   • 환경 변수 및 요청 관리
   • 협업 기능(최대 3명 무료)

Postman 사용법

1. 워크스페이스 생성:
   • Postman을 실행하고 “My Workspace”에 들어갑니다.
2. 새 Collection 생성:
   • “New Collection” 버튼을 클릭합니다.
3. Request 생성:
   • “Add Request”를 클릭하여 API 요청을 정의합니다.
4. API 호출:
   • URL과 필요한 매개변수를 입력하고 요청을 전송합니다.
5. 결과 확인:
   • 응답 데이터를 확인하고 이를 기반으로 개발 및 테스트를 진행합니다.

Postman으로 API 테스트하기

Postman을 사용해 DRF로 생성한 API를 호출해봅니다.

• URL: http://127.0.0.1:8000/api/v1/articles/json-drf
• 요청 타입: GET
• 결과: JSON 형태의 데이터 반환

협업

Postman은 팀원 간의 협업을 지원하며, 워크스페이스를 공유하여 효율적인 API 개발이 가능합니다.