Django REST framework 的快速入門教程

咱們將建立一個簡單的API，讓管理員用戶能查看，修改系統中的用戶和組。

項目搭建

建立一個新的Django項目，叫作 tutorial，而後開始一個新的app叫作 quickstart。

# 建立項目的目錄
mkdir tutorial
cd tutorial

# 建立一個虛擬環境（virtualenv），來隔離地搭依賴包（開發環境）
virtualenv env
source env/bin/activate  # 在windows環境下，咱們使用`env\Scripts\activate`

# 安裝Django 和 Django REST framework 到虛擬環境（virtualenv）中
pip install django
pip install djangorestframework

# 創建新項目和一個應用
django-admin.py startproject tutorial .  # 注意末尾的'.'符號
cd tutorial
django-admin.py startapp quickstart
cd ..

如今進行首次的數據庫同步吧：

python manage.py migrate

• 1

咱們也建立初始化的用戶，叫作 admin ，密碼爲 password123。 稍後的案例中，咱們將以該用戶來登錄驗證。

python manage.py createsuperuser

• 1

等你建好了數據庫，建立了初始用戶，一切準備完畢後，咱們打開app的目錄，而後開始編程啦……

序列器（Serializers）

首先，咱們來定義一些序列器。咱們來建立一個新的模塊（module）叫作 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')

須要注意的是，咱們在這個案例中，使用了超連接關係（hyperlinked relations），藉助的類是 HyperlinkedModelSerializer。你也可使用主鍵（primary key）和其它一些關係型(relationships)，但超連接（hyperlinking）是很是好的RESTful設計。

視圖（Views）

好吧，如今咱們最好是寫些視圖。打開 tutorial/quickstart/views.py 而後打起你的鍵盤吧～

from django.contrib.auth.models import User, Group
from rest_framework import viewsets
from tutorial.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()
    serializer_class = GroupSerializer

比起傳統的作法，須要寫不少視圖，咱們將全部的通常性行爲（common behavior）組成一個 ViewSets 類。 
若有須要，咱們可很輕易的將其，拆分紅數個單獨的視圖。但視圖組（viewsets）能讓視圖的邏輯結構清晰，並且簡潔。

URLs

好，如今咱們來裝配API的URLs。進入 tutorial/urls.py

from django.conf.urls import url, include
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)

# 使用自動化URL路由，轉配咱們的API.
# 若有額外須要, 我也爲可視化API添加了登錄URLs.
urlpatterns = [
    url(r'^', include(router.urls)),
    url(r'^api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

由於咱們用了視圖組（viewsets）而不是多個視圖，咱們能夠爲咱們的API自動的生成URL配置，只需簡單的將視圖組（viewsets）註冊到router類中便可。

一樣的，若是咱們須要對API URLs進行單獨控制，咱們可使用普通基於類（class based）的視圖，並詳細的配置每一個URL。

最後，咱們爲可視化API，添加登錄/登出視圖。這是可選的，但對於須要登錄驗證的API，以及可視化的API倒是很是的有用。

設置（Settings）

咱們也須要一些全局設置。咱們想要分頁（pagination），咱們但願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

• 1

使用API，能夠經過命令行，一些工具好比 curl(譯者注：Linux上的http工具)…

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"
        }
    ]
}

或直接使用瀏覽器… 
 
若是你藉助瀏覽器，請確保你在右上角的入口，進行了登錄。

很好，這很簡單！

若是你下剛要深刻理解REST framework是如何集成工做的，能夠從頭開始覆蓋官方教程，或者開始瀏覽API指引。