Django Rest Frameworkを使って、お手軽にAPIを作るお話です。

1. Django Rest Frameworkで
お手軽にREST APIを作る

2. 自己紹介
• 名前（年齢）
松尾 敬太（36歳）長崎県出身
• 家族
嫁、子供×２（女）
• 仕事
株式会社TechJIN
b→dashという
マーケティングプラットフォームで
分析に使うデータの前処理・加工・抽出
• 最近の出来事
ミニスーファミを買いました

3. 自己紹介

4. 目次
• Djangoって？
• REST APIができるまで（スライドで）
• 公式サイトのご紹介
• 【告知】fukuoka.exのご紹介

5. Django（Rest Framework）とは
• Django（ジャンゴ）
Pythonで実装されたWebアプリケーションフレームワーク（フルスタック）
MVCではなく、MTVで構成
Instagram、Pinterest等、多くの実績を持つ
参考：https://www.slideshare.net/tokibito/django-77900308
• Django Rest Framework
DjangoでRESTfulなAPIを作るための Framework
シンプルで強力な機能が一通り揃っている
REST APIの参考：http://wp.tech-style.info/archives/683#REST_API

6. REST APIができるまで

7. 前提や準備
• 必要なライブラリのインストール
pip install Django==1.11
pip install django-filter==1.0.4
pip install djangorestframework==3.6.3
pip install PyMySQL==0.7.11
• データベースの作成
今回はMySQLを使います。
「blog」というDBを作っておきます。今回作成するテーブルは以下の通り。
article
title char タイトル
content text 記事内容
status int 状態
member_id int 作成者
created_at datetime 作成日時
updated_at
datetime
更新日時
member
name char 名前
email char メール
birthday date 誕生日
created_at datetime 作成日時
updated_at
datetime
更新日時

8. プロジェクトとアプリケーション
• Djangoプロジェクトを作成
django-admin startproject mysite
• Djangoアプリケーションの作成
cd mysite
python manage.py startapp blog
• MySQLを使えるようにします
import pymysql
pymysql.install_as_MySQLdb()
mysite/manage.pyに以下を追加

9. 設定ファイルの変更
• mysite/mysite/settings.pyを変更
INSTALLED_APPS = (
...
'blog',
'rest_framework',
'django_filters',
)
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.mysql',
'NAME': 'blog',
'USER': 'root',
'PASSWORD': '',
'HOST': '',
'PORT': '',
}
}
LANGUAGE_CODE = 'ja-JP'
TIME_ZONE = 'Asia/Tokyo'

10. モデルの定義
• mysite/blog/models.pyに下記を記述
class Member(models.Model):
name = models.CharField(max_length=50)
email = models.EmailField()
birthday = models.DateField(null=True, default=None)
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)
class Article(models.Model):
STATUS_TYPE = (
(0, '下書き'),
(1, '公開中'),
)
title = models.CharField(max_length=255)
content = models.TextField()
status = models.IntegerField(choices=STATUS_TYPE)
member = models.ForeignKey(Member, related_name='articles')
created_at = models.DateTimeField(auto_now_add=True)
updated_at = models.DateTimeField(auto_now=True)

11. マイグレーションとスーパーユーザー
• マイグレーションの実行
python manage.py migrate
• Djangoのスーパーユーザーの作成
python manage.py createsuperuser
• マイグレーションファイルの作成
cd mysite ←プロジェクトトップ
python manage.py makemigrations
UsernameとPasswordを設定する
Djangoのadmin画面にログインするときに必要。

12. シリアライザーの定義
• mysite/blog/serializers.pyを作成し、下記を記述
from rest_framework import serializers
from .models import *
class MemberSerializer(serializers.ModelSerializer):
class Meta:
model = Member
fields = ('id', 'name', 'email', 'birthday')
class ArticleSerializer(serializers.ModelSerializer):
class Meta:
model = Article
fields = ('title', 'content', 'status')
• モデルから取得したデータをどういった項目で、どのような形式で
JSONに変換するかを定義する。
• POSTされてきた登録データをモデルに変換を行う。バリデーション
や登録を行う。

13. シリアライザーの定義（設定例）
class MemberSerializer(serializers.ModelSerializer):
birthday = serializers.DateField(format='%Y年%m月%d日')
class Meta:
model = Member
fields = ('id', 'name', 'email', 'birthday')
class ArticleSerializer(serializers.ModelSerializer):
member_id = serializers.IntegerField(write_only=True)
member = MemberSerializer(read_only=True)
class Meta:
model = Article
fields = ('title', 'content', 'status', 'member_id', 'member')
例1：リレーション先のデータもシリアライズ
例2：日付を年月日で

14. シリアライザーの定義（設定例）
class ArticleSerializer(serializers.ModelSerializer):
status_name = serializers.SerializerMethodField()
class Meta:
model = Article
fields = ('id', 'title', 'content', 'status', 'status_name')
def get_status_name(self, obj):
return obj.get_status_display()
例3：区分（状態）を名前で返す
class MemberSerializer(serializers.ModelSerializer):
birthday = serializers.DateField(input_formats=['%Y-%m-%d', '%Y/%m/%d'])
class Meta:
model = Member
fields = ('id', 'name', 'email', 'birthday')
例4：日付のバリデーションチェック（スラッシュ区切りかハイフン区切り）

15. class ArticleViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin,
viewsets.GenericViewSet):
def partial_update(self, request, *args, **kwargs):
serializer = self.get_serializer(self.get_object(), data=request.data, partial=True)
if not serializer.is_valid():
return Response(serializer.errors, 400)
serializer.save()
Member.objects.update_xx(serializer.data) # なんらかメンバー情報をカスタマイズ更新する
article = Article.objects.select_related('member').get(pk=serializer.data['id'])
ret_serializer = self.get_serializer(article)
return Response(ret_serializer.data, 200)
例5：カスタマイズなどで登録処理を手動で記述
シリアライザーの定義（設定例）

16. ビューセットの定義
• mysite/blog/views.pyに下記を記述
from rest_framework import viewsets
from .serializers import *
class MemberViewSet(viewsets.ModelViewSet):
queryset = Member.objects.all()
serializer_class = MemberSerializer
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
• ルーティングによって、振り分けられたリクエストをどう処理する
か定義する。

17. class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
permission_classes = (permissions.IsAuthenticated, )
filter_backends = (filters.DjangoFilterBackend, )
filter_fields = ('status',)
class ArticleViewSet(viewsets.ModelViewSet):
queryset = Article.objects.all()
serializer_class = ArticleSerializer
filter_backends = (filters.DjangoFilterBackend, )
filter_fields = ('status',)
例1：ある項目で検索したい場合（http://****/articles?status=1）
例2：Basic認証したい
※上記２例はsettings.pyの設定が必要です
ビューセットの定義（設定例）

18. class ArticleViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin,
viewsets.GenericViewSet):
def partial_update(self, request, *args, **kwargs):
serializer = self.get_serializer(self.get_object(), data=request.data, partial=True)
if not serializer.is_valid():
return Response(serializer.errors, 400)
serializer.save()
Member.objects.update_xx(serializer.data) # なんらかメンバー情報をカスタマイズ更新する
article = Article.objects.select_related('member').get(pk=serializer.data['id'])
ret_serializer = self.get_serializer(article)
return Response(ret_serializer.data, 200)
例3：部分更新APIのカスタマイズ
リストやIDでのデータ取得はデフォルト
機能を使い、それ以外はカスタマイズで
。
ビューセットの定義（設定例）

19. ルーティングの定義
• mysite/blog/urls.pyを作成し、下記を記述
from rest_framework import routers
from .views import *
router = routers.DefaultRouter()
router.register(r'members', MemberViewSet)
router.register(r'articles', ArticleViewSet)
• mysite/mysite/urls.pyに下記を記述
from django.conf.urls import url, include ← includeを追加
from django.contrib import admin
from blog.urls import router ← ここを追加
urlpatterns = [
url(r'^admin/', admin.site.urls),
url(r'^blog/', include(router.urls)) ← ここを追加
]

20. サーバー起動とアクセス
• Webサーバーを起動
cd mysite ←プロジェクトトップ
python manage.py runserver
• URLにアクセスして動いているのを確認
http://127.0.0.1:8000/blog/

21. 各APIにアクセスしてみる
• Memberに対するCRUDを確認
実演します
http://127.0.0.1:8000/blog/members/
• Articleで登録し、Memberまで取得できるのを確認
実演します
http://127.0.0.1:8000/blog/articles/

22. 公式サイトのご紹介
まだまだいろんな機能がありますので、ぜひ公式を見てください
http://www.django-rest-framework.org/

23. 福岡Elixirコミュ「fukuoka.ex」主催→採用企業増加
告知から17時間で満席、隔月定期開催 (偶数月)
次回は明後日開
催

24. ご静聴ありがとうございました