🔔 スクラップを限定公開で作成できるようになりました
Zenn
🚀

[Django] django rest framework環境構築/インストール

2023/07/29に公開
django
Python
初心者向け
tech

はじめに

社内の有志メンバーの活動で DRF を使用したので、導入方法を記録として残しておきます。

http://127.0.0.1:8000/books/list/にアクセスして
下記の画面が表示されるまでを解説します
drf-api-step01.png

0. ファイル構成の確認

下記のようなファイル構成で始めます

src
└─ backend

1. ライブラリーのインストール

  1. djangoとdjango rest frameworkを下記コマンドでインストールする
pip install django
pip install djangorestframework
  1. django の Version を確認する
$ pip show django
Name: Django
Version: 4.1.4
Summary: A high-level Python web framework that encourages rapid development and clean, pragmatic design.
Home-page: https://www.djangoproject.com/
Author: Django Software Foundation
Author-email: foundation@djangoproject.com
License: BSD-3-Clause
Location: /home/furuta/.local/lib/python3.9/site-packages
Requires: asgiref, sqlparse
Required-by:
  1. django rest framework の Version を確認する
$ pip show djangorestframework
Name: djangorestframework
Version: 3.14.0
Summary: Web APIs for Django, made easy.
Home-page: https://www.django-rest-framework.org/
Author: Tom Christie
Author-email: tom@tomchristie.com
License: BSD
Location: c:\users\furutan\appdata\local\programs\python\python310\lib\site-packages
Requires: django, pytz
Required-by:

2. 設定ファイルの作成

Django プロジェクトの設定を管理するためのconfigを作成します。

  1. カレントディレクトリをbackendに移動する
cd src/backend
  1. 下記コマンドで内にconfigファイルを作成します。
django-admin startproject config .
  1. config ファイルの作成後のファイル構成を確認する
src
└─ backend
     ├─ config
     │   ├─ __init__.py
     │   ├─ asgi.py
     │   ├─ settings.py
     │   ├─ urls.py
     │   └─ wsgi.py
     ├─ db.sqlite3
     └─ manage.py

3. アプリケーションの作成

アプリケーションのベースとなるファイルを作成します。

  1. 書籍の情報を管理するbooksというアプリケーションの作成するために、下記コマンドを実行します。
python manage.py startapp books
  1. アプリケーションの作成後のファイル構成を確認する
src
└─ backend
	├── books
	│   ├── __init__.py
	│   ├── admin.py
	│   ├── apps.py
	│   ├── migrations
	│   │   └── __init__.py
	│   ├── models.py
	│   ├── tests.py
	│   └── views.py
	├── config
	│   ├── __init__.py
	│   ├── asgi.py
	│   ├── settings.py
	│   ├── urls.py
	│   └── wsgi.py
	├── db.sqlite3
	└── manage.py

4. settings.py の編集

アプリケーションの起動が出来るようアプリケーション側の apps.py のクラスを追加します。

  1. INSTALLED_APPSの配列に'books.apps.BooksConfig',と'rest_framework',を追加します。
settings.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
+    'books.apps.BooksConfig',
+    'rest_framework',
]
  1. 言語とタイムゾーンをローカル環境にする
settings.py
# 日本時間
- LANGUAGE_CODE = 'en-us'
+ LANGUAGE_CODE = 'ja'

# 東京ゾーン
- TIME_ZONE = 'UTC'
+ TIME_ZONE = 'Asia/Tokyo'

5. ローカル環境で起動する

アプリケーションを実行します。

  1. python manage.py runserverで django を起動します
$ python manage.py runserver
Watching for file changes with StatReloader
Performing system checks...

System check identified no issues (0 silenced).

December 30, 2022 - 01:44:09
Django version 4.1.4, using settings 'config.settings'
Starting development server at http://127.0.0.1:8000/
Quit the server with CONTROL-C.
  1. ブラウザ上でアプリケーションを確認する
    http://127.0.0.1:8000/をブラウザの URL 欄に入力しアプリケーションを表示させます。
    無事に Django を起動する事が出来ました。
    Djangoインストール

6. models.py の作成

書籍の情報を管理するテーブル設計を行います
※models の書き方については下記記事を参考にしてください。

books/models.py
from django.db import models

# Create your models here.
class Books(models.Model):
   # 書籍のタイトル
   title = models.CharField(max_length=100)
   # 登録時の日付/時刻を登録する
   # auto_now_add: 登録時のみ
   created_at = models.DateTimeField(auto_now_add=True)
   # 更新時の日付/時刻を更新する
   updated_at = models.DateTimeField(auto_now=True)
   # 管理者画面で表示するデータをtitleの値を返す
   def __str__(self):
       return self.title

7. makemigrations の実行

下記コマンドを実行し、先ほど作成したモデルのbooksをmakemigrationsを行う

makemigrations を実行することで、Django にモデルに変更があったこと(この場合、新しいものを作成しました)を伝え、そして変更を マイグレーション の形で保存することができる。

python manage.py makemigrations books

実行結果は、下記の通りです

$ python manage.py makemigrations books
Migrations for 'books':
  books\migrations\0001_initial.py
    - Create model Books

books配下のmigrationsに下記のファイルが作成されます。

  • _init__.py
  • 0001_initial.py
 .
 └── backend
     ├── books
     │   ├── migrations
+    │   │   ├── __init__.py
+    │   │   └── 0001_initial.py
     │   ├── __init__.py
     │   ├── admin.py
     │   ├── apis.py
     │   ├── apps.py
     │   ├── models.py
     │   ├── serializers.py
     │   ├── tests.py
     │   ├── urls.py
     │   └── views.py
     ├── config
     │   ├── __pycache__
     │   │   ├── __init__.cpython-310.pyc
     │   │   ├── settings.cpython-310.pyc
     │   │   └── urls.cpython-310.pyc
     │   ├── __init__.py
     │   ├── asgi.py
     │   ├── settings.py
     │   ├── urls.py
     │   └── wsgi.py
     ├── db.sqlite3
     └── manage.py

8. migrate の実行

下記コマンドを実行し、booksの情報を DB に変更・適用します

migrate は、自動でデータベーススキーマを管理するためのコマンドです

python manage.py migrate

実行結果は、下記の通りです

$ python manage.py migrate
Operations to perform:
  Apply all migrations: admin, auth, books, contenttypes, sessions
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 admin.0003_logentry_add_action_flag_choices... 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 auth.0010_alter_group_name_max_length... OK
  Applying auth.0011_update_proxy_permissions... OK
  Applying auth.0012_alter_user_first_name_max_length... OK
  Applying books.0001_initial... OK
  Applying sessions.0001_initial... OK

9. serializers.py の作成

DB への入出力するデータをバリデーションや Json 形式に変換する処理を行うserializers.pyを作成します。
※新規でserializers.pyをファイル作成を行う

books/serializers.py
from rest_framework import serializers
from books.models import Books
from datetime import datetime

class BooksSerializer(serializers.ModelSerializer):

    created_at = serializers.DateTimeField(format="%Y-%m-%d %H:%M", read_only=True)
    updated_at = serializers.DateTimeField(format="%Y-%m-%d %H:%M", read_only=True)

    class Meta:
        model = Books
        fields = ['id', 'title', 'created_at', 'updated_at']

8. views の作成

CRUD 操作を行うために、views.pyを作成する

books/views.py
from django.shortcuts import render
from .models import Books
from rest_framework import viewsets
from .serializers import BooksSerializer

# Create your views here.
class BooksViewSet(viewsets.ModelViewSet):
    queryset = Books.objects.all()
    serializer_class = BooksSerializer

9. urls.py の作成

API の URL の設定を行う為、urls.pyを作成する

config/urls.py
  from django.contrib import admin
  from django.urls import path
+ from django.conf.urls import include

  urlpatterns = [
     path('admin/', admin.site.urls),
+    path('books/', include('books.urls'))
 ]
books/urls.py
from django.urls import path
from django.conf.urls import include
from rest_framework import routers
from .views import BooksViewSet

router = routers.DefaultRouter()
router.register('list', BooksViewSet)

urlpatterns = [
    path('', include(router.urls))
]

動作確認

1. 初期状態を確認する

アプリケーションを実行します。

  1. 下記コマンドを実行し、django を起動します
python manage.py runserver
  1. http://127.0.0.1:8000/books/list/にアクセスする
  2. まだデータを追加していないので、[]が確認出来る
    drf-api-step01.png

2. データを追加する(Create)

  1. Title欄に書籍のタイトルを入力する
  2. POSTボタンをクリックする
    drf-api-step02.png
  3. さきほど[]だったのが、データが追加されたことが確認出来ます。
    drf-api-step03.png

3. データを更新する(Update)

  1. 追加したデータのidを URL に追加し、http://127.0.0.1:8000/books/list/1/にアクセスする
  2. タイトルをリーダブルコードから新リーダブルコードに変更する
  3. POSTボタンをクリックする
    drf-api-step04.png
  4. Titleとupdated_atが更新されていることを確認出来る
    ※created_atは、設定ミスで更新されてしまいました。
    drf-api-step05.png

2. データを削除する(Delete)

  1. http://127.0.0.1:8000/books/list/1/にアクセスする
  2. DELETEボタンをクリックする
    drf-api-step06.png
  3. ポップアップのDeleteに対してもボタンをクリックする
    drf-api-step07.png
  4. 初期状態と同じデータが[]になる
    drf-api-step01.png

おわりに

django rest framework の環境構築の記事には、見つからなくて大変でした。
結局、Udemy を購入して学習しました。

GitHubで編集を提案

Discussion

ログインするとコメントできます