django REST API practice like a boss

pycharm 안녕.
django project 생성.

실행환경은 virtualenv로 3.6.x

virtualenv 생성에 약간 시간 소모.
setting.py와 urls.py가 반겨줌

djex1 프로젝트를 만들었음

__init__.py
settings.py
urls.py
wsgi.py

요렇게 생김.

자, 게임을 시작해볼까?
option+R 누름.

이런 애가 나옴.
startapp product 라고 쳐서 product 업무를 만들어보자.

자동완성이 된다.

product 아래

admin.py
apps.py
models.py
tests.py
views.py

이런 파일들이 생겼다. rails 생각이 난다.
내용물은 텅텅 비어서 실망스럽다.
comment라도 있을 줄 알았는데.
여튼 텍스트로 hello world 같은 건 안찍어본다. 바로 rest API
http://www.django-rest-framework.org/tutorial/quickstart/
돌입한다.
pip install djangorestframework
뭔가 설치했으니
requirements.txt로 pip freeze하여 깡통인 곳에서 설치할때 pip install -r requirements.txt로 설치할 수 있게 만들자.
pip freeze > requirements.txt

REST API framework는 설치했고 DB를 만들자.

먼저 migrate을 돌려주자.

option+R 상태에서 migrate 엔터

Running migrations:
  Applying contenttypes.0001_initial... OK
  Applying auth.0001_initial... OK
  Applying admin.0001_initial... OK
  Applying admin.0002_logentry_remove_auto_add... OK
  Applying contenttypes.0002_remove_content_type_name... OK
  Applying auth.0002_alter_permission_name_max_length... OK
  Applying auth.0003_alter_user_email_max_length... OK
  Applying auth.0004_alter_user_username_opts... OK
  Applying auth.0005_alter_user_last_login_null... OK
  Applying auth.0006_require_contenttypes_0002... OK
  Applying auth.0007_alter_validators_add_error_messages... OK
  Applying auth.0008_alter_user_username_max_length... OK
  Applying auth.0009_alter_user_last_name_max_length... OK
  Applying sessions.0001_initial... OK
Following files were affected
 /Users/spectrum/Documents/python/djex1/db.sqlite3

이런 식으로 죽 올라가고 db.sqlite3 이란 파일이 생겼다.

로컬디비가 기본이 sqlite다.

pycharm의 툴을 이용해서 연결해놓자.

아니 이렇게 좋은 것이?

만일 처음 sqlite data source를 추가하는 것이면 Download missing driver files 라고 나올 수도 있는데 Download를 누르면 알아서 드라이버를 받는다.

기본은 pycharm 에서 관리하는 경로인데 File: 에서 ... 을 눌러 현재 프로젝트의 db.sqlite3랑 연결하자.
Project에서 Copy Path 해놓은 걸 붙여넣기 하면 편하다.
Test Connection 눌러서 Successful 떨어지는 거 구경하고 OK

기본 서비스가 훌륭

DB가 있으니 모델을 만들자.
product/models.py 에 자동완성을 써가면서 만들어 보았다.

from django.db import models

class Product(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.TextField()
    price = models.IntegerField()
    createdAt = models.DateTimeField(auto_now_add=True)

오케이 makemigrations product 해보자
App 'product' could not be found. Is it in INSTALLED_APPS?

하고 묻는다.

djex1/settings.py 에 INSTALLED_APPS를 수정하자.

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    # apps
    'product',
]

시키는 대로 했다.

Migrations for 'product':

  product/migrations/0001_initial.py

    - Create model Product

Following files were affected 

 /Users/spectrum/Documents/python/djex1/product/migrations/0001_initial.py

migrations 파일이 생겼다.

Database는 변함이 없는데

방금 생성한 migrations 를 가지고 실제 table들을 만들자

option+R 상태에서 migrate

그리고 python console 에서 확인해보자.

PyDev console: starting.
Python 3.6.2 (v3.6.2:5fd33b5926, Jul 16 2017, 20:11:06)
[GCC 4.2.1 (Apple Inc. build 5666) (dot 3)] on darwin
Django 2.0.1
>>> from product.models import Product
>>> Product.objects.all()
<QuerySet []>

좋아보인다. import를 하는 순간. Product가 watch에 보이는게 좋다.

db 를 새로고침하면

테이블명이 엄하다.

업무명인 product에 entity명도 product 니 product_product로 나올 수 밖에.

https://gist.github.com/perrygeo/5380196

graphviz로 ERD도 뽑아보자.

brew install graphviz
pip install django-extensions
pip install pygraphviz

쭉 설치하고

djex1/settings.py 에 INSTALLED_APPS에 django-extensions 추가

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'product',
    # extension
    'django_extensions',]

option+R에서 graph_models product -o test.png 뽑아본다.

괜찮네.

어드민도 있었지. 한번 볼까.

option+R에서 createsuperuser

유저명/이메일/암호 다 넣고

녹색 삼각형 눌러서 django Rrrrrrrrrrrun!

createsuperuser로 진입하면 이렇게 된다.

groups/users가 기본이고 users에 admin계정 하나 달랑 들었다.

view 만들어 볼 차례다.

product/views.py 를 열고

from rest_framework.generics import ListAPIView
from rest_framework import serializers
from product.models import Product

3개를 import 하자. ListAPIView하고 serializers는 이 view에서 사용할 것이고 대상인 모델은 product.models의 Product이다.

실제로 화면에 연결할 View를 만들기 전에 Product model을 가져와보자.

그냥은 가져올 수 없고 serializers.ModelSerializer 를 사용하는 serializer를 먼저 만들어야한다.

class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product

이정도면 일단 오케이

여기에 실제 url 과 연결할 View를 만들자

class ProductsView(ListAPIView):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

중요한 건 queryset.

product/views.py는 이렇게 완성하자.

from rest_framework.generics import ListAPIView
from rest_framework import serializers
from product.models import Product

class ProductSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product

class ProductsView(ListAPIView):
    queryset = Product.objects.all()
    serializer_class = ProductSerializer

나머지는 연결하는 것만 남았다.

djex1/urls.py 의 최종모습은

from django.contrib import admin
from django.urls import include, path
from product.views import ProductsView

urlpatterns = [
    path('admin/', admin.site.urls),
    path('product/', ProductsView.as_view()),
]

이와 같다.

Class-based views

    1. Add an import:  from other_app.views import Home

    2. Add a URL to urlpatterns:  path('', Home.as_view(), name='home')

커멘트에 있는 내용대로 path와 View 클래스.as_view()로 연결했다.

API서버가 완성되었다.

http://127.0.0.1:13000/product/?format=json 하면 [] 값만 나오기도 한다.

django admin을 이용해 model로 만든 테이블에 값을 입력해보자.

product/admin.py 에서 admin.site.register() 를 사용하여 model을 추가한다.

model은 from product.models import Product 있으니

from django.contrib import admin
from product.models import Product
admin.site.register(Product)

이정도면 된다.
/admin 을 보자.

Product / Products가 나왔다.
+ Add 를 눌러서 데이터를 입력할 수 있다.

relation을 만들기 위해 Coupon도 한번 만들어보자.

class Coupon(models.Model):
    id = models.AutoField(primary_key=True)
    name = models.CharField(max_length=255)
    product_id = models.ForeignKey(
        Product,
        on_delete=models.CASCADE,
    )
    createdAt = models.DateTimeField(auto_now_add=True)

product_id라는 필드를 foreignkey로 product와 완결했다.

product삭제시에 같이 삭제되도록 models.CASCADE를 지정했다.

product/admin.py를 조금 손봐서

from django.contrib import admin
from product.models import Product, Coupon

class ProductAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'price')

class CouponAdmin(admin.ModelAdmin):
    list_display = ('id', 'name', 'product_id')

admin.site.register(Product, ProductAdmin)
admin.site.register(Coupon, CouponAdmin)

이렇게 만들고 django admin에서 값을 입력해보면

이 경우 Coupon -> Product 인 상태에서 

1. Coupon을 기준으로 Product 접근:
  Coupon.objects.get(id=2).product_id.price # 한개
  Coupon.objects.filter(id=2).select_related() # 일치하는 여러개

2. Product를 기준으로 Coupon 접근:
  Product.objects.get(id=2).coupon_set.all() # 한개
  Product.objects.filter(id=2).prefetch_related() # 일치하는 여러개

이 가능하다.

이번에 처음 django를 써봤는데 안정적이고 완성도 높은 framework이네.
admin하나만 해도 꽤 훌륭해보인다.