TIL44. Django : Django API with httpie

ID짱재·2021년 10월 19일

django

Django

목록 보기

34/43

📌 이 포스팅에서는 Django 프레임워크를 사용하여 API 설계하고, 이를 Create, Read하는 방법에 대해서 정리하였습니다.

🌈 Django API with httpie

🔥 API 생성 및 사용법 : POST

🔥 API 생성 및 사용법 : GET

🔥 보완 : List Comprehension 활용하여 View 작성하기

1. API 생성 및 사용법 : POST

🤔 클라이언트 준비하기

✔️ Server에 HTTP request 를 할 수 있는 방법으로는 웹브라우저, Httpie, Postman 등이 있다.

✔️ Httpie 설치 방법은 brew를 사용한다.

$ brew install httpie

✔️ httpie를 사용하여 POST 요청(string type)은 아래와 같이 한다. path를 적은 뒤, key와 value를 매핑한다.

$ http -v POST 127.0.0.1:8000/[path] key1="value1" key2="value2" key3="value3"

🤔 models.py 생성하기

✔️ POST 요청으로 온 message body의 값을 DB에 생성(CREATE)하기 위해서는 우선 models.py에 Table을 만든다.

✔️ Dog 테이블에 owner 컬럼은 ForeignKey로 Owner 모델을 참조시켜 서로 관계를 맺어준다.

from django.db import models
# 🚀 Owner table
class Owner(models.Model):
    name = models.CharField(max_length=45)
    email = models.CharField(max_length=300)
    age = models.IntegerField()
    class Meta:
        db_table = "owners"
# 🚀 Dog table        
class Dog(models.Model):
    name = models.CharField(max_length=45)
    age = models.IntegerField()
    owner = models.ForeignKey("Owner", on_delete=models.CASCADE)
    class Meta:
        db_table = "dogs"

🤔 Python은 JSON 형식을 바로 이해할 수 없다.

✔️ Python은 Dict형 자료구조가 있지만, 바로 JOSN형식을 이해할 수 없다. 이에 HTTP Message의 body 부분을 json.loads를 통해 Dict로 변환시켜 Python에서 처리해준다.

✔️ 처리 후 다시 JOSN 형식으로 값을 반환하기 위해 JSONResponse 모듈을 이용한다.

✔️ 성공을 의미하는 Status Code 중, 생성은 201번으로 반환하다.

✔️ 즉, JSON형식의 request를 받아올 때는 json.loads() 다시 JSON형식으로 response를 반환할 때는 JsonResponse를 사용한다.

import json
from django.http import JsonResponse
from django.views import View
from .models import Owner, Dog
# 🚀 OwnerView controller
class OwnerView(View):
    def post(self, request):
        try:
            data = json.loads(request.body)
            Owner.objects.create(
                name=data["name"], email=data["email"], age=data["age"]
            )
        except KeyError:
            return JsonResponse({"MESSAGE": "IVALID_KEY"}, status=400)
        return JsonResponse({"MESSAGE": "CREATED"}, status=201)
# 🚀 DogView controller
class DogView(View):
    def post(self, request):
        try:
            data = json.loads(request.body)
            Dog.objects.create(
                name=data["name"],
                age=data["age"],
                owner=Owner.objects.get(name=data["owner"]),
            )
        except KeyError:
            return JsonResponse({"MESSAGE": "IVALID_KEY"}, status=400)
        return JsonResponse({"MESSAGE": "CREATED"}, status=201)

🤔 Path는 자원(Resource)을 식별할 수 있게 되도록 명사를 사용한다.

✔️ 클라이언트는 URI 통해 서버에 요청하는데 이 경로는 자원을 정확히 식별할 수 있도록 구성되어야 한다. 행위는 매서드(GET, POST..)로 구분하기 때문에 최대한 자원을 명확히 나타내대록 URL를 설계해야 한다.

✔️ 메인 urls.py에서 owners 앱의 urls.py로 처리를 위임하도록 include를 사용하여 지정한다.

from django.urls import path, include
urlpatterns = [
    path("", include("owners.urls")),
]

✔️ OwnerView와 DogView에 대한 path는 아래와 같이 지정해준다.

from django.urls import path
from .views import OwnerView, DogView
urlpatterns = [
    path("owner/", OwnerView.as_view()),
    path("dog/", DogView.as_view()),
]

✔️ 이제 key&value 형태로 Httpi 요청(POST)을 보내면, MySQL의 DB에 값이 저장된 것을 확인할 수 있다. 단, Controller가 작동할 수 있도록 urls.py의 path를 경로를 지정해주어야 한다.

$ http -v POST 127.0.0.1:8000/owner name="장재원" age=33 email="jewon119@gmail.com"
$ http -v POST 127.0.0.1:8000/dog name="복실이" age=7 owner="장재원"

2. API 생성 및 사용법 : GET

🤔 데이터 READ를 위한 GET 매서드를 추가해보자.

✔️ HTTP 매서드가 POST로 요청올 때는 해당 CBV(Class-based-View)에 post 매서드가 실행되고, GET 매서드로 요청온다면 CBV에 get 매서드가 작동한다.

✔️ DB에서 데이터와 Dict형으로 처리한 후, 가공한 데이터를 JsonResponse을 사용해 JSON형식으로 클라이언트로 반환해주면 된다.

import json
from django.http import JsonResponse
from django.views import View
from .models import Owner, Dog
# 🚀 OwnerView controller
class OwnerView(View):
    def post(self, request): # 👈 POST 요청일 때 작동
        ......생략......
    def get(self, request): # 👈 GET 요청일 때 작동
        owners = Owner.objects.all()
        result = []
        for owner in owners:
            dogs = owner.dog_set.all()
            dog_list = []
            for dog in dogs:
                dog_data = {
                    "name": dog.name,
                    "age": dog.age,
                }
                dog_list.append(dog_data)
            result.append(
                {
                    "name": owner.name,
                    "mail": owner.email,
                    "age": owner.age,
                    "my_dogs": dog_list,
                }
            )
        return JsonResponse({"MESSAGE": result}, status=200)
# 🚀 DogView controller
class DogView(View):
    def post(self, request):
        ......생략......
    def get(self, request):
        dogs = Dog.objects.all()
        result = []
        for dog in dogs:
            result.append(
                {
                    "name": dog.name,
                    "age": dog.age,
                    "owner": dog.owner.name,
                }
            )
        return JsonResponse({"MESSAGE": result}, status=200)

✔️ 이제 아래와 같이 Httpi 요청을 보내면, DB에서 값을 불러와 JSON형태로 반환해준다.

$ http -v GET 127.0.0.1:8000/owner 👈 OwnerView에 get 매서드 작동
$ http -v GET 127.0.0.1:8000/dog 👈 DogView에 get 매서드 작동

3. 보완 : Comprehension 문법 활용하여 View 작성하기

🤔 for문을 통해 자료구조를 만드는 것보다 Comprehension이 속도가 빠르다.

✔️ Comprehension 문법은 List, Dict, Tulple 등 모두 사용할 수 있고, for문을 통해 append하는 것보다 속도가 빠르다.

import json
from django.http import JsonResponse
from django.views import View
from .models import Owner, Dog
# 🚀 OwnerView controller
class OwnerView(View):
    def post(self, request):
        try:
            data = json.loads(request.body)
            Owner.objects.create(
                name=data["name"], email=data["email"], age=data["age"]
            )
        except KeyError:
            return JsonResponse({"MESSAGE": "IVALID_KEY"}, status=400)
        return JsonResponse({"MESSAGE": "CREATED"}, status=201)
    def get(self, request): # 👈 2중 List Comprehension
        result = [
            {
                "name": owner.name,
                "mail": owner.email,
                "age": owner.age,
                "my_dogs": [
                    {"name": dog.name, "age": dog.age} for dog in owner.dogs.all() # 👈 related_name 사용으로 "dogs"로 역참조
                ],
            }
            for owner in Owner.objects.all()
        ]
        return JsonResponse({"MESSAGE": result}, status=200)
# 🚀 DogView controller
class DogView(View):
    def post(self, request):
        try:
            data = json.loads(request.body)
            Dog.objects.create(
                name=data["name"],
                age=data["age"],
                owner=Owner.objects.get(name=data["owner"]),
            )
        except KeyError:
            return JsonResponse({"MESSAGE": "IVALID_KEY"}, status=400)
        return JsonResponse({"MESSAGE": "CREATED"}, status=201)
    def get(self, request): # 👈 List Comprehension
        result = [
            {
                "name": dog.name,
                "age": dog.age,
                "owner": dog.owner.name,
            }
            for dog in Dog.objects.all()
        ]
        return JsonResponse({"MESSAGE": result}, status=200)