PythonでREST APIを作る準備

初心者

Posted at 2025-03-27

PythonとDjangoを使ってローカル環境でAPIを作成する流れを順を追って説明します。以下は基本的な手順です。

1. Djangoのインストールとプロジェクトの作成

まず、Djangoをインストールしてプロジェクトを作成します。

# 仮想環境を作成（任意）
python -m venv venv
source venv/bin/activate  # Windowsの場合は venv\Scripts\activate

# Djangoのインストール
pip install django

# 新しいDjangoプロジェクトを作成
django-admin startproject myproject
cd myproject

# アプリケーションを作成
python manage.py startapp myapp

2. データベースの設定

settings.py でデータベースを設定します。DjangoはデフォルトでSQLiteを使うので、そのままで問題ありませんが、必要に応じて他のデータベースに変更できます。

3. モデルの作成

models.py でデータベースのテーブルを作成します。例えば、Bookというテーブルを作成する場合、次のように書きます。

# myapp/models.py

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_date = models.DateField()

    def __str__(self):
        return self.title

4. マイグレーションの実行

モデルをデータベースに反映させるために、マイグレーションを行います。

# マイグレーションファイルを作成
python manage.py makemigrations

# データベースにマイグレーションを適用
python manage.py migrate

5. APIの作成

次に、APIを作成するためにDjango REST Frameworkを使います。

# Django REST Frameworkをインストール
pip install djangorestframework

次に、settings.pyでrest_frameworkをインストールしたアプリケーションに追加します。

# myproject/settings.py

INSTALLED_APPS = [
    # 既存のアプリケーション...
    'rest_framework',
    'myapp',  # 自分のアプリケーションを追加
]

6. シリアライザーの作成

シリアライザーを使って、モデルをJSON形式で変換します。

# myapp/serializers.py

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = '__all__'

7. ビューの作成

次に、APIエンドポイントを作成するためにビューを作成します。views.pyに次のコードを書きます。

# myapp/views.py

from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

8. URLの設定

最後に、APIのURLを設定します。urls.pyに以下の設定を追加します。

# myapp/urls.py

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

router = DefaultRouter()
router.register(r'books', BookViewSet)

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

そして、myproject/urls.pyにmyapp.urlsをインクルードします。

# myproject/urls.py

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

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('myapp.urls')),  # ここでアプリケーションのURLを追加
]

9. サーバーの起動と動作確認

サーバーを起動し、APIが正しく動作するか確認します。

# サーバーを起動
python manage.py runserver

ブラウザで http://127.0.0.1:8000/api/books/ にアクセスすると、Bookテーブルのデータが表示されるはずです。

10. APIのデータ操作

これで、APIを通じてデータの取得、追加、更新、削除ができるようになります。たとえば、POSTリクエストを使って新しい本を追加したり、GETリクエストで本のリストを取得したりできます。

これでDjangoを使ってAPIを作成する準備が整いました。データベースの操作をAPI経由で行えるようになるので、必要に応じて認証や認可を追加することもできます。

Djangoにおける「モデル」と「マイグレーション」は、データベース操作を簡単にするための重要な機能です。これらの必要性や特徴について説明します。

1. モデル (Model)

必要性：

モデルは、Djangoのアプリケーションでデータベースのテーブル構造を定義するために使用します。Djangoは「ORM (Object-Relational Mapping)」を使用して、Pythonのクラスをデータベースのテーブルと対応させます。これにより、SQLを直接書かずに、Pythonのコードだけでデータベース操作を行えるようになります。

特徴：

データ構造の定義: モデルはデータベーステーブルの構造を定義します。たとえば、どのフィールドがどんな型か（文字列、数値、日付など）を指定します。
オブジェクト指向: モデルはPythonのクラスで定義され、各インスタンス（オブジェクト）はデータベースの1行に対応します。オブジェクトとしてデータを扱うことができるため、プログラム的に直感的です。
フィールドタイプ: モデルのクラス内でフィールドを定義します。Djangoは様々なフィールドタイプ（CharField, IntegerField, DateField, ForeignKey など）を提供しています。
バリデーションと制約: モデル内で、フィールドに対して制約（最大長、必須フィールドなど）を設定できます。

例:

# myapp/models.py

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=100)  # 本のタイトル（文字列）
    author = models.CharField(max_length=100)  # 著者（文字列）
    published_date = models.DateField()  # 発行日（日時）

2. マイグレーション (Migration)

必要性：

マイグレーションは、データベースのスキーマ（テーブルやフィールドの構造）を更新するための手段です。モデルを変更すると、それに対応するデータベースのテーブルやカラムも更新する必要があります。マイグレーションは、その変更をデータベースに適用する手続きです。

特徴：

モデルの変更に対応: モデルに変更を加えると、Djangoはその変更をマイグレーションファイルとして記録します。このマイグレーションファイルを使って、データベースの構造を更新できます。
履歴管理: マイグレーションは履歴として保存されるため、どの変更がいつ適用されたかを追跡できます。また、過去に遡って変更を取り消す（ロールバック）ことも可能です。
データベースとコードの同期: マイグレーションを使うことで、コードの変更（モデルの変更）とデータベースのスキーマを同期させることができます。これにより、開発チーム間で一貫したデータベース構造が保たれます。

マイグレーションの操作：

マイグレーションファイルの作成: モデルに変更を加えた後、Djangoはその変更をマイグレーションファイルとして生成します。
```
python manage.py makemigrations
```
マイグレーションの適用: マイグレーションファイルをデータベースに適用して、テーブルやカラムを作成・更新します。
```
python manage.py migrate
```

例:

例えば、Bookモデルにpriceというフィールドを追加したい場合、以下のように変更を加えます。

# myapp/models.py

class Book(models.Model):
    title = models.CharField(max_length=100)
    author = models.CharField(max_length=100)
    published_date = models.DateField()
    price = models.DecimalField(max_digits=10, decimal_places=2)  # 価格を追加

変更後、マイグレーションを作成し、適用します。

python manage.py makemigrations
python manage.py migrate

3. モデルとマイグレーションのまとめ

モデルは、データベースのテーブルの設計図をPythonのクラスとして定義する役割を果たします。これにより、データベース操作が簡潔に行えます。
マイグレーションは、モデルの変更をデータベースに反映させるための手段です。マイグレーションを使って、データベーススキーマをコードと同期させ、変更を管理します。

Djangoのモデルとマイグレーションは、データベースの設計や変更を効率的に管理できるため、開発をスムーズに進めるための大事なツールです。

仮想環境って何？

仮想環境というのは、Pythonのプロジェクトごとに独立した環境を作成し、その中で必要なライブラリ（パッケージ）をインストールして運用するための仕組みです。これにより、複数のプロジェクトで異なるライブラリのバージョンを使ったり、依存関係を管理したりすることができます。

仮想環境の目的

プロジェクトごとの依存関係の管理:
- 各プロジェクトが必要とするライブラリのバージョンが異なることがあります。仮想環境を使うことで、プロジェクトごとに必要なパッケージやそのバージョンを独立して管理できます。
- これにより、他のプロジェクトのライブラリに影響を与えずに作業できます。
グローバルなPython環境の汚染を防ぐ:
- 仮想環境を使わずにライブラリをインストールすると、システム全体のPython環境（グローバル環境）にライブラリが追加されます。仮想環境を使えば、システム全体のPython環境が汚染されることを防げます。

仮想環境の作成と使用方法

仮想環境の作成:
仮想環境を作成するためには、Pythonに標準で搭載されている venv モジュールを使うことが一般的です。以下のコマンドで仮想環境を作成できます。
```
python -m venv myenv
```
これで、myenv という名前の仮想環境が作成されます。
仮想環境のアクティベート（有効化）:
仮想環境を作成した後、その環境を有効にする必要があります。以下のコマンドで仮想環境をアクティベートできます。
- Windowsの場合:
```
myenv\Scripts\activate
```
- macOS/Linuxの場合:
```
source myenv/bin/activate
```
仮想環境をアクティベートすると、ターミナルのプロンプトが変更され、仮想環境内で作業していることがわかります。
仮想環境内でのライブラリのインストール:
仮想環境がアクティベートされている状態で、必要なライブラリをインストールできます。例えば、Djangoをインストールする場合は、以下のコマンドを実行します。
```
pip install django
```
仮想環境のデアクティベート（無効化）:
仮想環境を終了したい場合は、以下のコマンドで仮想環境を無効化できます。
```
deactivate
```
仮想環境の利用例:
- プロジェクトAでDjangoの1.10バージョンを使っていて、プロジェクトBではDjangoの3.0バージョンを使う場合、仮想環境を使えばそれぞれのプロジェクトで異なるバージョンを管理できます。
- 仮想環境内で、プロジェクトに必要なパッケージをインストールして管理し、他のプロジェクトに影響を与えないようにします。

まとめ

仮想環境は、プロジェクトごとに独立したPython環境を作り、その中でライブラリや依存関係を管理するための仕組みです。これにより、異なるプロジェクトで異なるバージョンのライブラリを使いたい場合や、システム全体の環境を汚さずに開発を進めたい場合に非常に便利です。

python manage.py startapp myapp を実行すると、Django プロジェクト内に新しいアプリケーション（myapp）を作成します。Django のアプリケーションとは、特定の機能やサービスを提供するコードのセットで、プロジェクト内で分割して管理できるようにするものです。

`startapp` が実行された後の構成

コマンドを実行すると、次のようなディレクトリ構造が作成されます。

myproject/
 ├── manage.py
 ├── myproject/
 │    ├── __init__.py
 │    ├── settings.py
 │    ├── urls.py
 │    ├── asgi.py
 │    ├── wsgi.py
 ├── myapp/        ← 新しく作成されたアプリケーション
 │    ├── __init__.py
 │    ├── admin.py
 │    ├── apps.py
 │    ├── models.py
 │    ├── tests.py
 │    ├── views.py

新しく作成されるファイルとディレクトリ

myapp/（アプリケーションディレクトリ）
Django プロジェクト内の個別の機能やサービスを管理するためのフォルダ。
アプリケーションごとに、モデル、ビュー、URL などを整理できます。
__init__.py
Python のモジュールを示すファイルで、空でも構いませんが、アプリケーションが Python パッケージであることを示します。
admin.py
Django の管理画面にアプリケーションのデータを表示するための設定を記述します。
例えば、モデルを管理画面で管理できるようにするための設定をここに書きます。
apps.py
アプリケーションの設定ファイルです。アプリケーション名や設定情報がここに記載されます。
例: myapp アプリケーションの設定が記載されています。
models.py
データベースのテーブルに対応する モデル を定義する場所です。
ここに定義したクラスが、Django ORM（Object-Relational Mapping）を使ってデータベースとやり取りします。
tests.py
アプリケーションのテストケースを記述する場所です。
ここにテストコードを追加して、アプリケーションの動作確認をします。
views.py
HTTP リクエストに対して レスポンス を返すための関数やクラスを記述する場所です。
このファイルで、URL パターンとビューの対応を行います。

アプリケーションの役割と特徴

アプリケーションとは
Django プロジェクト内で 特定の機能を担うモジュール です。
例えば、ブログのアプリケーション、ユーザー管理のアプリケーション、注文処理のアプリケーションなどが考えられます。
プロジェクト vs アプリケーション
- プロジェクトは、Django プロジェクト全体を指します。
- アプリケーションは、特定の 機能単位 のコードです。
  例えば、myapp というアプリケーションがユーザー管理機能、blog というアプリケーションがブログ機能を持つようなイメージです。
1つのプロジェクトで複数のアプリケーション
同じ Django プロジェクト内に、複数のアプリケーションを作成することができます。これによって、コードを分割しやすくなり、機能ごとに独立して管理できます。

次のステップ

startapp でアプリケーションを作成した後、通常は以下のような作業を行います。

1. `settings.py` にアプリケーションを追加

myapp を INSTALLED_APPS に追加します。これで Django がアプリケーションを認識します。

INSTALLED_APPS = [
    ...
    'myapp',
    ...
]

2. モデルの定義

models.py でデータベースのテーブルに対応するモデルを作成します。

3. マイグレーション

モデルを作成したら、マイグレーションを実行してデータベースを更新します。

python manage.py makemigrations myapp
python manage.py migrate

4. ビューとURLの設定

views.py でビューを定義し、urls.py でそのビューに対応する URL パターンを設定します。

まとめ

python manage.py startapp myapp は、Django プロジェクト内に新しいアプリケーションを作成するコマンドです。
アプリケーションには、models.py や views.py などのファイルが作成され、これらを使って機能を実装していきます。
アプリケーションを作成した後は、プロジェクトの設定ファイル（settings.py）にアプリを追加し、必要に応じてマイグレーションやビューの設定を行います。

試してみて、さらに詳しい部分で不明点があれば教えてね！

わかりやすくするために、具体的な Django プロジェクトの例を使って、各ファイルが何をしているのかを説明します。

例えば、ブログアプリケーションを作るプロジェクトを想定してみましょう。このプロジェクトでは、ユーザーがブログ記事を投稿して、一覧や詳細を見ることができるサイトを作ります。

プロジェクトのファイル構成

myproject/
 ├── manage.py
 ├── myproject/
 │    ├── __init__.py
 │    ├── settings.py
 │    ├── urls.py
 │    ├── asgi.py
 │    ├── wsgi.py
 ├── blog/
 │    ├── __init__.py
 │    ├── views.py
 │    ├── models.py
 │    ├── serializers.py
 │    ├── forms.py
 │    ├── urls.py
 │    ├── tests/
 │    │    └── test_models.py
 ├── static/
 │    └── css/
 ├── templates/
 │    └── base.html
 │    └── blog/
 │         ├── index.html
 │         └── detail.html

各ファイルの役割

1. `myproject/settings.py`

Django プロジェクト全体の設定ファイル。データベースやアプリケーションの設定をここに書きます。
例えば、INSTALLED_APPS にどのアプリケーションを使うか設定します。

INSTALLED_APPS = [
    'blog',  # このプロジェクトで使うアプリケーション
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
]

2. `myproject/urls.py`

プロジェクト全体の URL ルーティングを定義します。ここで、特定の URL を特定のビューに紐づけます。
例えば、blog/ の URL パターンを blog.urls という別ファイルに分けて読み込む設定にします。

from django.contrib import admin
from django.urls import path, include  # include を使って他のアプリの urls を読み込む

urlpatterns = [
    path('admin/', admin.site.urls),
    path('blog/', include('blog.urls')),  # blog アプリケーションの URL を読み込む
]

3. `blog/models.py`

モデルを定義するファイルです。データベースに保存するためのデータ構造をここで作成します。
例えば、ブログの記事を保存するための Post モデルを作成します。

from django.db import models

class Post(models.Model):
    title = models.CharField(max_length=200)
    content = models.TextField()
    published_date = models.DateTimeField(auto_now_add=True)
    
    def __str__(self):
        return self.title

Post モデルでは、記事のタイトル、内容、公開日時をデータベースに保存します。

4. `blog/views.py`

ビューを定義するファイルです。ユーザーからのリクエストに対して、どのデータを返すか、どのテンプレートを表示するかを決めます。
例えば、ブログの投稿一覧ページを表示するビューを作成します。

from django.shortcuts import render
from .models import Post

def index(request):
    posts = Post.objects.all()  # データベースから全ての投稿を取得
    return render(request, 'blog/index.html', {'posts': posts})  # テンプレートに渡す

5. `blog/urls.py`

アプリケーション内の URL 設定を定義します。例えば、ブログのトップページ（一覧ページ）や、個別の投稿ページへの URL ルーティングをここで設定します。

from django.urls import path
from . import views

urlpatterns = [
    path('', views.index, name='index'),  # トップページにアクセスしたときの処理
]

6. `blog/templates/blog/index.html`

テンプレートファイルです。Django のビューから渡されたデータを HTML に埋め込んで、ブラウザに表示するためのファイルです。
例えば、ブログの投稿一覧を表示するための HTML を書きます。

<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <title>Blog</title>
</head>
<body>
    <h1>Blog Posts</h1>
    <ul>
        {% for post in posts %}
            <li>{{ post.title }} - {{ post.published_date }}</li>
        {% endfor %}
    </ul>
</body>
</html>

{{ post.title }} や {{ post.published_date }} は Django のテンプレートエンジンを使って、ビューから渡されたデータを表示しています。

7. `blog/forms.py`

フォームを定義するファイルです。ユーザーがデータを送信するためのフォーム（例：ブログ記事投稿フォーム）を作成します。
例えば、ブログ投稿のフォームを作成する場合は以下のようになります。

from django import forms
from .models import Post

class PostForm(forms.ModelForm):
    class Meta:
        model = Post
        fields = ['title', 'content']

これで、ユーザーがブログ記事を投稿するためのフォームが作成できます。

8. `blog/tests/test_models.py`

テストを記述するファイルです。Django アプリケーションの動作を自動的にテストするためのコードを記述します。
例えば、ブログのモデルが正しく動作するかどうかをテストします。

from django.test import TestCase
from .models import Post

class PostModelTest(TestCase):
    
    def test_post_creation(self):
        post = Post.objects.create(
            title="Test Post",
            content="This is a test post."
        )
        self.assertEqual(post.title, "Test Post")
        self.assertEqual(post.content, "This is a test post.")

9. `static/css/`

CSS ファイルを格納するディレクトリです。ページの見た目（スタイル）を変更するためのスタイルシートをここに置きます。

body {
    font-family: Arial, sans-serif;
}

h1 {
    color: #333;
}

まとめ

models.py でデータベース構造（例えば、ブログ記事）を作り、
views.py でデータを取得してテンプレートに渡し、
templates フォルダ内で HTML を作成して、ユーザーに表示します。

これらのファイルが連携して、最終的にウェブページを作り上げることができます。

You get articles that match your needs
You can efficiently read back useful information
You can use dark theme

What you can do with signing up

PythonでREST APIを作る準備

1. Djangoのインストールとプロジェクトの作成

2. データベースの設定

3. モデルの作成

4. マイグレーションの実行

5. APIの作成

6. シリアライザーの作成

7. ビューの作成

8. URLの設定

9. サーバーの起動と動作確認

10. APIのデータ操作

1. モデル (Model)

必要性：

特徴：

例:

2. マイグレーション (Migration)

必要性：

特徴：

マイグレーションの操作：

例:

3. モデルとマイグレーションのまとめ

仮想環境の目的

仮想環境の作成と使用方法

まとめ

startapp が実行された後の構成

新しく作成されるファイルとディレクトリ

アプリケーションの役割と特徴

次のステップ

1. settings.py にアプリケーションを追加

2. モデルの定義

3. マイグレーション

4. ビューとURLの設定

まとめ

プロジェクトのファイル構成

各ファイルの役割

1. myproject/settings.py

2. myproject/urls.py

3. blog/models.py

4. blog/views.py

5. blog/urls.py

6. blog/templates/blog/index.html

7. blog/forms.py

8. blog/tests/test_models.py

9. static/css/

まとめ

`startapp` が実行された後の構成

1. `settings.py` にアプリケーションを追加

1. `myproject/settings.py`

2. `myproject/urls.py`

3. `blog/models.py`

4. `blog/views.py`

5. `blog/urls.py`

6. `blog/templates/blog/index.html`

7. `blog/forms.py`

8. `blog/tests/test_models.py`

9. `static/css/`