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

項目設(shè)置

創(chuàng)建一個名為 tutorial 的新django項目，然后啟動一個名為 quickstart 的新app。

# 創(chuàng)建項目目錄mkdir tutorial cd tutorial# 創(chuàng)建一個virtualenv來隔離我們本地的包依賴關(guān)系virtualenv env source env/bin/activate # 在Windows下使用 `env\Scripts\activate`# 在創(chuàng)建的虛擬環(huán)境中安裝 Django 和 Django REST frameworkpip install django pip install djangorestframework# 創(chuàng)建一個新項目和一個單個應用django-admin.py startproject tutorial . # 注意結(jié)尾的'.'符號cd tutorial django-admin.py startapp quickstart cd ..

現(xiàn)在第一次同步你的數(shù)據(jù)庫：

python manage.py migrate

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

python manage.py createsuperuser

等你建立好一個數(shù)據(jù)庫和初始用戶，并準備好開始。打開應用程序的目錄，我們就要開始編碼了…

Serializers

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

from django.contrib.auth.models import User, Group from rest_framework import serializersclass UserSerializer(serializers.HyperlinkedModelSerializer):class Meta:model = Userfields = ('url', 'username', 'email', 'groups')class GroupSerializer(serializers.HyperlinkedModelSerializer):class Meta:model = Groupfields = ('url', 'name')

請注意，在這個例子中我們用到了超鏈接關(guān)系，使用 HyperlinkedModelSerializer。你還可以使用主鍵和各種其他關(guān)系，但超鏈接是好的RESTful設(shè)計。

Views

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

from django.contrib.auth.models import User, Group from rest_framework import viewsets from tutorial.quickstart.serializers import UserSerializer, GroupSerializerclass UserViewSet(viewsets.ModelViewSet):"""允許用戶查看或編輯的API路徑。"""queryset = User.objects.all().order_by('-date_joined')serializer_class = UserSerializerclass GroupViewSet(viewsets.ModelViewSet):"""允許組查看或編輯的API路徑。"""queryset = Group.objects.all()serializer_class = GroupSerializer

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

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

URLs

好的，現(xiàn)在我們在tutorial/urls.py中開始寫連接API的URLs。

from django.conf.urls import url, include from rest_framework import routers from tutorial.quickstart import viewsrouter = 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進行更多的控制，我們可以簡單地將其拉出來使用常規(guī)基于類的視圖，并明確地編寫URL conf。

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

Settings

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

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

好了，我們完成了。

---

測試我們的API

我們現(xiàn)在可以測試我們構(gòu)建的API。我們從命令行啟動服務(wù)器。

python manage.py runserver

我們現(xiàn)在可以從命令行訪問我們的API，使用諸如 curl …

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

或者使用 httpie，命令行工具…

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

或直接通過瀏覽器，轉(zhuǎn)到URL http://127.0.0.1:8000/users/…

如果您正在使用瀏覽器，請確保使用右上角進行登錄。

非常棒！就是這么簡單！

參考鏈接：https://www.django.cn/course/show-20.html

總結(jié)

以上是生活随笔為你收集整理的Django REST Framework（DRF）教程:快速入门的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。