Django REST Framework教程:快速入門

咱們將建立一個簡單的容許管理員用戶查看和編輯系統中的用戶和組的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
}

測試咱們的API

咱們如今能夠測試咱們構建的API。咱們從命令行啓動服務器。

python manage.py runserver

直接經過瀏覽器，轉到URL http://127.0.0.1:8000/users/...

 

 detail": "Authentication credentials were not provided

沒有提供身份驗證憑據

 

點擊右上login

 

 輸入以前的用戶名，密碼進行登陸

 

 原文連接：https://www.django.cn/course/show-20.html

---

掃碼關注微信公衆號  「小樊Study」獲取更多

 

直男們，掃我送女朋友喲！