GitHub 検索 Django REST framework

クイックスタート

管理者ユーザーがシステム内のユーザーとグループを表示および編集できる簡単なAPIを作成します。

プロジェクトのセットアップ

tutorialという名前の新しいDjangoプロジェクトを作成し、次にquickstartという名前の新しいアプリを開始します。

# Create the project directory
mkdir tutorial
cd tutorial

# Create a virtual environment to isolate our package dependencies locally
python3 -m venv env
source env/bin/activate  # On Windows use `env\Scripts\activate`

# Install Django and Django REST framework into the virtual environment
pip install django
pip install djangorestframework

# Set up a new project with a single application
django-admin startproject tutorial .  # Note the trailing '.' character
cd tutorial
django-admin startapp quickstart
cd ..

プロジェクトのレイアウトは次のようになります。

$ pwd
<some path>/tutorial
$ find .
.
./tutorial
./tutorial/asgi.py
./tutorial/__init__.py
./tutorial/quickstart
./tutorial/quickstart/migrations
./tutorial/quickstart/migrations/__init__.py
./tutorial/quickstart/models.py
./tutorial/quickstart/__init__.py
./tutorial/quickstart/apps.py
./tutorial/quickstart/admin.py
./tutorial/quickstart/tests.py
./tutorial/quickstart/views.py
./tutorial/settings.py
./tutorial/urls.py
./tutorial/wsgi.py
./env
./env/...
./manage.py

アプリケーションがプロジェクトディレクトリ内に作成されているのは珍しいかもしれません。プロジェクトの名前空間を使用すると、外部モジュールとの名前の衝突を回避できます（これはクイックスタートの範囲外のトピックです）。

次に、データベースを初めて同期します。

python manage.py migrate

また、パスワード付きのadminという名前の初期ユーザーを作成します。後で例でそのユーザーとして認証します。

python manage.py createsuperuser --username admin --email admin@example.com

データベースを設定し、初期ユーザーが作成されて準備ができたら、アプリのディレクトリを開いてコーディングを開始します。

シリアライザー

まず、シリアライザーを定義します。データ表現に使用するtutorial/quickstart/serializers.pyという名前の新しいモジュールを作成しましょう。

from django.contrib.auth.models import Group, User
from rest_framework import serializers


class UserSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = User
        fields = ['url', 'username', 'email', 'groups']


class GroupSerializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Group
        fields = ['url', 'name']

この場合、HyperlinkedModelSerializerでハイパーリンクされたリレーションを使用していることに注意してください。主キーやその他のさまざまなリレーションシップも使用できますが、ハイパーリンクは優れたRESTful設計です。

ビュー

それでは、ビューをいくつか作成しましょう。tutorial/quickstart/views.pyを開いて入力を開始します。

from django.contrib.auth.models import Group, User
from rest_framework import permissions, viewsets

from tutorial.quickstart.serializers import GroupSerializer, UserSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows users to be viewed or edited.
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer
    permission_classes = [permissions.IsAuthenticated]


class GroupViewSet(viewsets.ModelViewSet):
    """
    API endpoint that allows groups to be viewed or edited.
    """
    queryset = Group.objects.all().order_by('name')
    serializer_class = GroupSerializer
    permission_classes = [permissions.IsAuthenticated]

複数のビューを作成するのではなく、すべての共通の動作をViewSetsと呼ばれるクラスにグループ化しています。

必要に応じて、これらを個々のビューに簡単に分解できますが、ビューセットを使用すると、ビューロジックが整理され、非常に簡潔になります。

URL

さて、APIのURLを配線しましょう。tutorial/urls.pyに移動します...

from django.urls import include, path
from rest_framework import routers

from tutorial.quickstart import views

router = routers.DefaultRouter()
router.register(r'users', views.UserViewSet)
router.register(r'groups', views.GroupViewSet)

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)),
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

ビューの代わりにビューセットを使用しているので、ルータークラスにビューセットを登録するだけで、APIのURL構成を自動的に生成できます。

繰り返しになりますが、APIのURLをより細かく制御する必要がある場合は、通常のクラスベースのビューを使用し、URL構成を明示的に記述できます。

最後に、ブラウズ可能なAPIで使用するためのデフォルトのログインビューとログアウトビューを含めます。これはオプションですが、APIに認証が必要で、ブラウズ可能なAPIを使用する場合は便利です。

ページネーション

ページネーションを使用すると、1ページあたりに返されるオブジェクトの数を制御できます。有効にするには、次の行をtutorial/settings.pyに追加します。

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination',
    'PAGE_SIZE': 10
}

設定

'rest_framework'をINSTALLED_APPSに追加します。設定モジュールはtutorial/settings.pyにあります。

INSTALLED_APPS = [
    ...
    'rest_framework',
]

はい、これで完了です。

APIのテスト

これで、構築したAPIをテストする準備ができました。コマンドラインからサーバーを起動しましょう。

python manage.py runserver

これで、curlのようなツールを使用して、コマンドラインからAPIにアクセスできるようになりました...

bash: curl -u admin -H 'Accept: application/json; indent=4' http://127.0.0.1:8000/users/
Enter host password for user 'admin':
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin",
            "email": "admin@example.com",
            "groups": []
        }
    ]
}

または、httpie、コマンドラインツールを使用して...

bash: http -a admin http://127.0.0.1:8000/users/
http: password for admin@127.0.0.1:8000:: 
$HTTP/1.1 200 OK
...
{
    "count": 1,
    "next": null,
    "previous": null,
    "results": [
        {
            "email": "admin@example.com",
            "groups": [],
            "url": "http://127.0.0.1:8000/users/1/",
            "username": "admin"
        }
    ]
}

または、URL http://127.0.0.1:8000/users/に移動して、ブラウザから直接アクセスできます...

Quick start image

ブラウザを使用している場合は、右上のコントロールを使用してログインしてください。

素晴らしい、簡単でした！

REST frameworkがどのように組み合わさっているかをより深く理解したい場合は、チュートリアルに進むか、APIガイドの閲覧を開始してください。