[파이썬][Django] API 뷰 함수 사용 방법과 예제

29 Aug 2023

django

Django에서 API 뷰 함수를 작성하고 사용하는 방법과 예제를 제공하겠습니다. API 뷰 함수는 Django REST framework와 같은 패키지를 사용하여 RESTful API 엔드포인트를 처리하는 데 사용됩니다.

API 뷰 함수 작성

먼저, API 뷰 함수를 작성합니다. 이 함수는 HTTP 요청을 처리하고 응답을 반환합니다. 예를 들어, 간단한 사용자 목록을 반환하는 API 뷰 함수를 만들어보겠습니다.

# myapp/views.py
    
    from rest_framework.response import Response
    from rest_framework.decorators import api_view
    from myapp.models import User
    from myapp.serializers import UserSerializer
    
    @api_view(['GET'])
    def get_users(request):
        users = User.objects.all()
        serializer = UserSerializer(users, many=True)
        return Response(serializer.data)

위의 코드는 `GET` 요청을 처리하고 모든 사용자를 가져와서 `UserSerializer`를 사용하여 JSON으로 직렬화한 후 응답합니다.

URL 매핑 설정

API 뷰 함수를 URL에 매핑합니다. 이를 위해 Django의 URL 매핑 시스템을 사용합니다.

# myapp/urls.py
    
    from django.urls import path
    from myapp.views import get_users
    
    urlpatterns = [
        path('api/users/', get_users, name='get_users'),
    ]

위의 코드에서 `/api/users/`는 사용자 목록을 반환하는 엔드포인트입니다.

API 호출 및 결과 확인

이제 /api/users/ 엔드포인트를 호출하고 JSON 응답을 받을 수 있습니다. 예를 들어, Python에서 requests 라이브러리를 사용하여 API를 호출하는 방법은 다음과 같습니다.

import requests
    
    response = requests.get('http://example.com/api/users/')
    
    if response.status_code == 200:
        user_data = response.json()
        print(user_data)
    else:
        print('API 호출에 실패했습니다.')

위의 코드는 API 엔드포인트에서 반환된 JSON 데이터를 파싱하여 사용자 목록을 출력합니다.

이것으로 Django에서 API 뷰 함수를 작성하고 사용하여 RESTful API를 개발하는 방법을 알게되었습니다. 이를 통해 Django 애플리케이션에서 API를 구축할 수 있습니다.