Django REST Frameworkで素早く簡単にバックエンドのAPIを開発してみる

# 仮想環境を作成
$ pipenv install

# 仮想環境に入る
$ pipenv shell

#　必要ライブラリをインポート
(hgoe)$ pipenv install django
(hgoe)$ pipenv install djangorestframework

# Djangoプロジェクトを作成(今回プロジェクト名は例としてconfig)
(hgoe)$ django-admin startproject config

# ディレクトリ移動
(hgoe)$ cd config

# 開発用サーバーを起動
(hgoe)$ python manage.py runserver

LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

(hoge)$ python manage.py startapp blog

# Application definition
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'blog',  # 追加
    'rest_framework',  # 追加
]

from django.db import models
from django.conf import settings

# AbstractBaseUserを利用してUserモデルをカスタマイズ
from django.contrib.auth.models import AbstractBaseUser

# PermissionsMixinを用いてUserの認証を行う
from django.contrib.auth.models import PermissionsMixin

# BaseUserManager利用してUserManagerモデルをカスタマイズ
from django.contrib.auth.models import BaseUserManager


class UserProfileManager(BaseUserManager):
    """ カスタムユーザーマネージャー """

    # ユーザを作成するメソッド
    def create_user(self, email, name, password=None):
        """ ユーザー作成 """

        if not email:
            raise ValueError('User must have an email address')

        # emailのドメインを小文字に変換
        email = self.normalize_email(email)

        # UserProfileモデルを参照してuserを定義
        user = self.model(email=email, name=name)

        # userが入力したパスワードをハッシュ化
        user.set_password(password)

        # settings.pyでdefaultに設定されているDBに保存
        user.save(using=self._db)

        return user

    def create_superuser(self, email, name, password):
        """ スーパーユーザー作成 """

        # 上記create_userを利用
        user = self.create_user(email, name, password)

        # superuserの権限を適用
        user.is_superuser = True
        user.is_staff = True
        user.save(using=self._db)

        return user


class UserProfile(AbstractBaseUser, PermissionsMixin):
    """ カスタムユーザーモデル """

    email = models.EmailField(max_length=255, unique=True)
    name = models.CharField(max_length=255)

    # ユーザが退会したらfalseにして論理削除
    is_active = models.BooleanField(default=True)

    # 管理画面にアクセスを許可するか
    is_staff = models.BooleanField(default=False)

    # UserProfileManagerのメソッドを使えるようにする
    objects = UserProfileManager()

    # emailを利用したログイン認証に変更
    USERNAME_FIELD = 'email'

    # 必須項目追加
    REQUIRED_FIELDS = ['name']

    # 1つのnameフィールドで表示したいので、既存のメソッドをオーバーライド
    def get_full_name(self):
        return self.name

    def get_short_name(self):
        return self.name

    # 管理画面などで表示される文字列を定義
    def __str__(self):
        return self.name


class Blog(models.Model):
    title = models.CharField(blank=False, null=False, max_length=150)
    text = models.TextField(blank=True)
    created_datetime = models.DateTimeField(auto_now_add=True)
    updated_datetime = models.DateTimeField(auto_now=True)

    # 外部キー
    author = models.ForeignKey(
        settings.AUTH_USER_MODEL, related_name='blog', on_delete=models.CASCADE, default=1)

    def __str__(self):
        return self.title

# ユーザ認証を変更
AUTH_USER_MODEL = 'blog.UserProfile'

(hoge)$ python manage.py makemigrations
(hoge)$ python manage.py migrate

(hoge)$ python manage.py createsuperuser

from django.contrib import admin
from .models import Blog, UserProfile


class UserProfileAdmin(admin.ModelAdmin):
    # 一覧表示画面のフィールド
    list_display = ('name', 'email', 'is_active', 'is_staff')
    # フィールドをリンク化
    list_display_links = ('name', 'email')


class BlogAdmin(admin.ModelAdmin):
    list_display = ('title', 'text', 'created_datetime',
                    'updated_datetime', 'author')
    list_display_links = ('title', 'text')


# 管理画面に登録
admin.site.register(Blog, BlogAdmin)
admin.site.register(UserProfile, UserProfileAdmin)

from blog import serializers
from .models import Blog, UserProfile
from rest_framework import generics
from rest_framework import viewsets


# ListAPIView メソッド：GET 一覧取得
class BlogView(generics.ListAPIView):
    queryset = Blog.objects.all()
    serializer_class = serializers.BlogSerializer


# RetrieveAPIView メソッド：GET 単一取得
class BlogDetailView(generics.RetrieveAPIView):
    queryset = Blog.objects.all()
    serializer_class = serializers.BlogSerializer


# ModelViewSet　1つのエンドポイントでmodelに紐付いたCRUD処理を実装してくれる
class UserProfileViewSet(viewsets.ModelViewSet):
    queryset = UserProfile.objects.all()
    serializer_class = serializers.UserProfileSerializer

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    # 管理画面を表示
    path('admin/', admin.site.urls),
    # APIへの入り口
    path('api/', include('blog.urls')),
]

from django.urls import path, include
from blog import views
from rest_framework.routers import DefaultRouter

router = DefaultRouter()
# ユーザーのCRUD処理用
router.register('profile', views.UserProfileViewSet)

urlpatterns = [
    # ブログ一覧取得用
    path('blog/', views.BlogView.as_view(), name='blog'),
    # ブログ詳細取得用
    path('blog/<str:pk>/', views.BlogDetailView.as_view(), name='blog_detail'),
    # router接続用
    path('', include(router.urls)),
]

from rest_framework import serializers
from .models import Blog, UserProfile


class UserProfileSerializer(serializers.ModelSerializer):
    class Meta:

        # Serializersに紐付けるmodelを定義
        model = UserProfile

        # APIとして出力したいカラムを定義（タプル形式）
        fields = ('id', 'email', 'name', 'password')

        #　fieldsの制限設定(定義したカラム名をkeyに取る)
        extra_kwargs = {
            'password': {

                # セキュリティの関係上パスワードは書き込むだけ。
                'write_only': True,

                # パスワード入力の際に「・・・」となるようにstyleを指定
                'style': {'input_type': 'password'}
            }
        }

    # ModelSerializerにデフォルトで実装されているメソッドをオーバーライド(パスワードのハッシュ化処理)
    def create(self, validated_data):
        user = UserProfile.objects.create_user(
            email=validated_data['email'],
            name=validated_data['name'],
            password=validated_data['password'],
        )
        return user

    def update(self, instance, validated_data):
        if 'password' in validated_data:
            password = validated_data.pop('password')
            instance.set_password(password)
        return super().update(instance, validated_data)


class BlogSerializer(serializers.ModelSerializer):
    
    class Meta:
        model = Blog
        fields = ('id', 'text', 'created_datetime',
                  'updated_datetime', 'author')