Python Django 入門トップページ


Django REST Framework による API 開発

  1. API とプロジェクトの概要
  2. Django REST Frameworkのインストール
  3. プロジェクトの作成
  4. 基本設定
  5. アプリケーションの作成と登録
  6. モデルの作成とマイグレーション
  7. テストデータの設定
  8. コメント一覧を出力する API
  9. コメント詳細情報を出力する API
  10. 新規投稿と更新・削除の API
  11. ページネーション
  12. 入力内容の検証(バリデーション)
  13. テストの自動化
  14. Shell でのユーザ登録
  15. Fixtures でのユーザ登録
  16. ユーザ認証を必須にする
  17. コメントにオーナ情報を追加
  18. 権限の設定:Case #1
  19. 権限の設定:Case #2
  20. Python から API への接続
  21. React アプリケーションからの API 接続と CORS エラーの回避

Django REST Framework による API 開発

プロジェクトの作成

それでは Django のプロジェクトを作成します.今回のプロジェクト名は django_comment_api とします.まず,適当なフォルダ(今回は Documents\Django)に移動します.

(base) C:\Users\rinsaka>cd Documents ⏎

(base) C:\Users\rinsaka\Documents>cd Django ⏎

(base) C:\Users\rinsaka\Documents\Django>dir ⏎
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は 9807-E930 です

 C:\Users\rinsaka\Documents\Django のディレクトリ

2023/11/23  13:41    <DIR>          .
2023/11/23  13:41    <DIR>          ..
               0 個のファイル                   0 バイト
               2 個のディレクトリ  61,122,150,400 バイトの空き領域

(base) C:\Users\rinsaka\Documents\Django>

Django のプロジェクトを新規に作成し,プロジェクトのフォルダに移動します.

(base) C:\Users\rinsaka\Documents\Django>django-admin startproject django_comment_api ⏎

(base) C:\Users\rinsaka\Documents\Django>dir ⏎
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は 9807-E930 です

 C:\Users\rinsaka\Documents\Django のディレクトリ

2023/11/23  13:47    <DIR>          .
2023/11/23  13:47    <DIR>          ..
2023/11/23  13:47    <DIR>          django_comment_api
               0 個のファイル                   0 バイト
               3 個のディレクトリ  60,151,300,096 バイトの空き領域

(base) C:\Users\rinsaka\Documents\Django>cd django_comment_api ⏎

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>dir ⏎
 ドライブ C のボリューム ラベルがありません。
 ボリューム シリアル番号は 9807-E930 です

 C:\Users\rinsaka\Documents\Django\django_comment_api のディレクトリ

2023/11/23  13:47    <DIR>          .
2023/11/23  13:47    <DIR>          ..
2023/11/23  13:47    <DIR>          django_comment_api
2023/11/23  13:47               696 manage.py
               1 個のファイル                 696 バイト
               3 個のディレクトリ  60,151,300,096 バイトの空き領域

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>

Git によるバージョン管理を行う場合は,まず最初のコミットを行なっておくと良いでしょう.

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>git init ⏎
Initialized empty Git repository in C:/Users/rinsaka/Documents/Django/django_comment_api/.git/

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>git add . ⏎

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>git commit -m"initial commit" ⏎
[master (root-commit) 0597e05] initial commit
 6 files changed, 199 insertions(+)
 create mode 100644 django_comment_api/__init__.py
 create mode 100644 django_comment_api/asgi.py
 create mode 100644 django_comment_api/settings.py
 create mode 100644 django_comment_api/urls.py
 create mode 100644 django_comment_api/wsgi.py
 create mode 100644 manage.py

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>

また,Git のコミットに含める必要のないファイルを .gitignore によって指定します.プロジェクトのフォルダに .gitignore ファイルを作成して,次の内容を指定します.(なお,.DS_Store は macOS で必要になるもので,Windows の場合は指定しなくても(指定しても)かまいません.)

.gitignoredb.sqlite3
*/__pycache__/
*/*/__pycache__/
.coverage
htmlcov
.DS_Store

ファイルを編集したら Git でコミットするようにしてください.

なお,プロンプトが次のとおり長くなるので,

(base) C:\Users\rinsaka\Documents\Django\django_comment_api>

以降のページでは次のとおり省略して表示することにします.

...\django_comment_api>

目次に戻る