Django REST Framework教程:快速入門

本文轉載自查看原文 2019-10-24 16:23 2405 DRF

我們將創建一個簡單的允許管理員用戶查看和編輯系統中的用戶和組的API。

項目設置

利用pycharm創建一個名為 tutorial 的新django項目，並創建一個名為 quickstart 的新app。

目錄結構

在創建的虛擬環境中安裝Django REST framework

pip install djangorestframework

查看安裝的第三方庫

現在第一次同步你的數據庫：

python manage.py migrate

我們還要創建一個名為 admin 的初始用戶，密碼為 public。我們稍后將在該示例中驗證該用戶。

python manage.py createsuperuser

等你建立好一個數據庫和初始用戶，並准備好開始。打開應用程序的目錄，我們就要開始編碼了...

Serializers

首先我們要定義一些序列化程序。我們創建一個名為 tutorial/quickstart/serializers.py的文件，來用作我們的數據表示。

from django.contrib.auth.models import User, Group
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

Views

好了，我們接下來再寫一些視圖。打開 tutorial/quickstart/views.py 文件開始寫代碼了。

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from quickstart.serializers import UserSerializer, GroupSerializer


class UserViewSet(viewsets.ModelViewSet):
    """
    允許用戶查看或編輯的API路徑。
    """
    queryset = User.objects.all().order_by('-date_joined')
    serializer_class = UserSerializer


class GroupViewSet(viewsets.ModelViewSet):
    """
    允許組查看或編輯的API路徑。
    """
    queryset = Group.objects.all()

不再寫多個視圖，我們將所有常見行為分組寫到叫 ViewSets 的類中。

如果我們需要，我們可以輕松地將這些細節分解為單個視圖，但是使用viewsets可以使視圖邏輯組織良好，並且非常簡潔。

URLs

現在我們在tutorial/urls.py中開始寫連接API的URLs。

from django.conf.urls import url, include
from rest_framework import routers
from quickstart import views

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

# 使用自動URL路由連接我們的API。
# 另外，我們還包括支持瀏覽器瀏覽API的登錄URL。
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

因為我們使用的是viewsets而不是views，所以我們可以通過簡單地使用路由器類注冊視圖來自動生成API的URL conf。

再次，如果我們需要對API URL進行更多的控制，我們可以簡單地將其拉出來使用常規基於類的視圖，並明確地編寫URL conf。

最后，我們將包括用於支持瀏覽器瀏覽的API的默認登錄和注銷視圖。這是可選的，但如果您的API需要身份驗證，並且你想要使用支持瀏覽器瀏覽的API，那么它們很有用。

Settings

我們也想設置一些全局設置。我們想打開分頁，我們希望我們的API只能由管理員使用。設置模塊都在 tutorial/settings.py 中。

INSTALLED_APPS = (
    ...
    'rest_framework',
)

REST_FRAMEWORK = {
    'DEFAULT_PERMISSION_CLASSES': [
        'rest_framework.permissions.IsAdminUser',
    ],
    'PAGE_SIZE': 10
}