画像






画像






この記事は、「Django Advent Calendar 2019」の22日目の記事です。






DjangoでJWT認証のAPIを構築してみました！




事前準備


環境

  • Python v3.6.0
  • Django v2.2.1
  • Django REST framework v3.9.3


今回は、JWT認証のAPIを構築してみます！




まずは、各モジュールをインストールします。


Simple JWTをインストール

pip install djangorestframework_simplejwt

画像


djoserをインストール

pip install djoser

画像


django-cors-headersをインストール

pip install django-cors-headers

画像




認証に利用するユーザーも事前に作成

python manage.py createsuperuser

画像




次に、Djangoのコードを記述します。




./config


settings.py

import os

#日付・時刻操作モジュール
from datetime import timedelta

# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/2.2/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = ''

# SECURITY WARNING: don't run with debug turned on in production!
DEBUG = True

ALLOWED_HOSTS = []


# Application definition

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'sample.apps.SampleConfig',
    'api.apps.ApiConfig',
    'rest_framework',
    #djoserを読み込み
    'djoser',
    #django cors headersを読み込み
    'corsheaders'
]

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    #django cors headersを読み込み
    'corsheaders.middleware.CorsMiddleware'
]

ROOT_URLCONF = 'config.urls'

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages'
            ],
        },
    },
]

WSGI_APPLICATION = 'config.wsgi.application'


# Database
# https://docs.djangoproject.com/en/2.2/ref/settings/#databases

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.sqlite3',
        'NAME': os.path.join(BASE_DIR, 'db.sqlite3')
    }
}


# Password validation
# https://docs.djangoproject.com/en/2.2/ref/settings/#auth-password-validators

AUTH_PASSWORD_VALIDATORS = [
    {
        'NAME': 'django.contrib.auth.password_validation.UserAttributeSimilarityValidator'
    },
    {
        'NAME': 'django.contrib.auth.password_validation.MinimumLengthValidator'
    },
    {
        'NAME': 'django.contrib.auth.password_validation.CommonPasswordValidator'
    },
    {
        'NAME': 'django.contrib.auth.password_validation.NumericPasswordValidator'
    },
]


# Internationalization
# https://docs.djangoproject.com/en/2.2/topics/i18n/

LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

USE_I18N = True

USE_L10N = True

USE_TZ = True


# Static files (CSS, JavaScript, Images)
# https://docs.djangoproject.com/en/2.2/howto/static-files/

STATIC_URL = '/static/'

#Django REST frameworkの設定
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        #Simple JWTの読み込み
        'rest_framework_simplejwt.authentication.JWTAuthentication'
    ],
}

#Simple JWTの設定
SIMPLE_JWT = {
    #トークンをJWTに設定
    'AUTH_HEADER_TYPES': ('JWT',),
    #トークンの持続時間の設定
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=60)
}

# CORSの設定
# すべて許可
CORS_ORIGIN_ALLOW_ALL = True


トークンの設定に利用するため、日付・時刻操作するモジュールをインポートします。

#日付・時刻操作モジュール
from datetime import timedelta


djoserとdjango cors headersを読み込みます。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'sample.apps.SampleConfig',
    'api.apps.ApiConfig',
    'rest_framework',
    #djoserを読み込み
    'djoser',
    #django cors headersを読み込み
    'corsheaders'
]


django cors headersのミドルウェアクラスを追加します。

MIDDLEWARE = [
    'django.middleware.security.SecurityMiddleware',
    'django.contrib.sessions.middleware.SessionMiddleware',
    'django.middleware.common.CommonMiddleware',
    'django.middleware.csrf.CsrfViewMiddleware',
    'django.contrib.auth.middleware.AuthenticationMiddleware',
    'django.contrib.messages.middleware.MessageMiddleware',
    'django.middleware.clickjacking.XFrameOptionsMiddleware',
    #django cors headersを読み込み
    'corsheaders.middleware.CorsMiddleware'
]


Django REST frameworkにJWTの設定を追加します。

#Django REST frameworkの設定
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [
        #Simple JWTの読み込み
        'rest_framework_simplejwt.authentication.JWTAuthentication'
    ],
}


トークンの種類と時間を設定します。

#Simple JWTの設定
SIMPLE_JWT = {
    #トークンをJWTに設定
    'AUTH_HEADER_TYPES': ('JWT',),
    #トークンの持続時間の設定
    'ACCESS_TOKEN_LIFETIME': timedelta(minutes=60)
}


CORSの設定をします。

# CORSの設定
# すべて許可
CORS_ORIGIN_ALLOW_ALL = True




./config


urls.py

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

urlpatterns = [
    path('admin/', admin.site.urls),
    path('sample/', include('sample.urls')),
    path('api/', include('api.urls')),
    #api/authアプリケーションのURLconf読み込み
    path('api/auth/', include('djoser.urls.jwt'))
]


認証のトークンURLを追加します。実際にアクセスするURLは「api/auth/jwt/create」になります。

#api/authアプリケーションのURLconf読み込み
path('api/auth/', include('djoser.urls.jwt'))




./api


views.py

from rest_framework import viewsets

#パーミッション設定
from rest_framework.permissions import IsAuthenticated

from sample.models import MainList
from sample.models import SubList
from .serializers import MainListSerializer
from .serializers import SubListSerializer

class MainListViewSet(viewsets.ModelViewSet):
    queryset = MainList.objects.all()
    serializer_class = MainListSerializer
    #認証済のみアクセス可能
    permission_classes = [IsAuthenticated]

class SubListViewSet(viewsets.ModelViewSet):
    queryset = SubList.objects.all()
    serializer_class = SubListSerializer
    #認証済のみアクセス可能
    permission_classes = [IsAuthenticated]


パーミッションモジュールをインポートします。

#パーミッション設定
from rest_framework.permissions import IsAuthenticated


各APIを認証済の場合のみアクセスできるように設定します。

#認証済のみアクセス可能
permission_classes = [IsAuthenticated]




最後に簡易サーバーを起動します。

python manage.py runserver


APIにアクセスしてみます。認証されていないので値を取得できません。

curl http://127.0.0.1:8000/api/sublist/ | jq .

画像


作成したユーザーを引数にトークンを取得します。

curl http://127.0.0.1:8000/api/auth/jwt/create -H "Accept: application/json" -H "Content-type: application/json" -X POST -d '{"username":"sample","password":"samplesample"}'

画像


取得したトークンを指定し、もう一度APIにアクセスしてみます。認証されて正常に値がレスポンスされるのが確認できます。

curl http://127.0.0.1:8000/api/sublist/ -H 'Authorization: JWT [トークンを入力]' | jq .

画像




最後にPostmanでも表示してみます。

画像






DjangoでJWT認証のAPIの構築ができました！


Django REST frameworkとSimple JWTを組み合わせることで、DjangoでJWT認証APIの構築できることが確認できました。バックエンドはAPI配信、フロントエンドはUIや動きによりフォーカスした分離ができそうです！




Djangoについて、他にも記事を書いています。よろしければぜひ。
tags - Django





book


Q&A