導(dǎo)言

Django REST框架的定義和目的

Django REST框架，通常簡(jiǎn)稱為DRF，是一個(gè)強(qiáng)大而靈活的Web API工具包。使用DRF，開發(fā)者可以快速構(gòu)建可擴(kuò)展的、可維護(hù)的RESTful API服務(wù)。DRF提供了一整套的工具和模塊，包括認(rèn)證、權(quán)限、序列化、視圖、路由等，幫助我們處理許多Web開發(fā)中常見的問題。

DRF的主要目的是使Django應(yīng)用程序能夠輕松地構(gòu)建和管理API。此外，DRF還關(guān)注API的可瀏覽性和易用性，使得開發(fā)者可以通過Web瀏覽器訪問API，并進(jìn)行交互。

Django REST框架和其他框架（如Flask）的比較

雖然Django REST框架和其他Python的Web框架（如Flask）有著共同的目標(biāo)，即幫助開發(fā)者構(gòu)建Web應(yīng)用，但是它們?cè)谠O(shè)計(jì)理念、功能和使用場(chǎng)景上有所不同。

• 設(shè)計(jì)理念：DRF是一個(gè)比較“重量級(jí)”的框架，提供了一整套的解決方案，包括模型、視圖、模板、表單、路由、認(rèn)證、權(quán)限等等。而Flask更加輕量級(jí)和靈活，它只提供了最基礎(chǔ)的工具，其他的功能需要通過安裝擴(kuò)展來(lái)實(shí)現(xiàn)。

# Django view示例
from django.http import HttpResponse
def hello_world(request):
    return HttpResponse("Hello, World!")

# Flask view示例
from flask import Flask
app = Flask(__name__)
@app.route('/')
def hello_world():
    return 'Hello, World!'

• 功能：DRF提供了許多內(nèi)建的功能，如認(rèn)證、權(quán)限、序列化、反序列化、視圖、路由等，這些功能都經(jīng)過了精心設(shè)計(jì)，使得開發(fā)者可以更加專注于業(yè)務(wù)邏輯，而不是基礎(chǔ)設(shè)施的建設(shè)。而Flask則更加注重靈活性，它允許開發(fā)者選擇和定制所需要的功能。
• 使用場(chǎng)景：如果你的項(xiàng)目需要快速構(gòu)建RESTful API，或者需要與Django的其他部分（如ORM、模板系統(tǒng)等）緊密集成，那么DRF可能是一個(gè)更好的選擇。如果你需要更大的靈活性，或者只需要構(gòu)建一個(gè)簡(jiǎn)單的Web服務(wù)，那么Flask可能更合適。

基礎(chǔ)部分

Django REST框架的安裝和設(shè)置

在開始使用Django REST框架前，首先需要安裝和配置相關(guān)環(huán)境。假設(shè)你已經(jīng)安裝了Python和Django，你可以使用pip來(lái)安裝DRF：

pip install djangorestframework

然后，需要將rest_framework添加到你的Django項(xiàng)目的INSTALLED_APPS配置中：

# settings.py

INSTALLED_APPS = [
    ...,
    'rest_framework',
]

這樣，我們就成功安裝和配置好了Django REST框架，接下來(lái)可以開始構(gòu)建我們的第一個(gè)DRF項(xiàng)目了。

一個(gè)基本的Django REST框架項(xiàng)目搭建教程

在本教程中，我們將創(chuàng)建一個(gè)簡(jiǎn)單的API，用于管理圖書信息。首先，我們需要?jiǎng)?chuàng)建一個(gè)新的Django app：

python manage.py startapp books

然后，我們需要在books app中定義我們的模型：

# models.py

from django.db import models

class Book(models.Model):
    title = models.CharField(max_length=200)
    author = models.CharField(max_length=100)
    published_date = models.DateField()

    def __str__(self):
        return self.title

接著，我們需要定義對(duì)應(yīng)的Serializer和Viewset：

# serializers.py
from rest_framework import serializers
from .models import Book
class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id', 'title', 'author', 'published_date']
# views.py
from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer
class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

最后，我們需要在urls.py中添加路由：

# urls.py

from django.urls import include, path
from rest_framework.routers import DefaultRouter
from .views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

以上就是一個(gè)基本的Django REST框架項(xiàng)目的搭建過程。在這個(gè)例子中，我們創(chuàng)建了一個(gè)可以進(jìn)行CRUD操作的圖書信息API。

Django REST框架中的基本組件：Serializers, Viewsets, Routers

在上面的例子中，我們使用了DRF的三個(gè)主要組件：Serializers, Viewsets, 和 Routers。以下是它們的簡(jiǎn)單介紹：

• Serializers：負(fù)責(zé)將復(fù)雜的數(shù)據(jù)類型（如Django模型實(shí)例）轉(zhuǎn)換為可以被渲染成JSON、XML等格式的Python數(shù)據(jù)類型。同時(shí)，也可以用于解析上述格式的數(shù)據(jù)，轉(zhuǎn)換為復(fù)雜的數(shù)據(jù)類型。
• Viewsets：一個(gè)用于封裝視圖邏輯的類。與Django的類視圖類似，但提供了更多與REST相關(guān)的功能，例如默認(rèn)的GET、POST、PUT、PATCH和DELETE方法。
• Routers：負(fù)責(zé)自動(dòng)生成URL路由。與Django的URLconf類似，但是對(duì)于DRF的Viewsets有更好的支持，可以根據(jù)Viewset中的方法自動(dòng)創(chuàng)建對(duì)應(yīng)的路由。

在接下來(lái)的部分，我們將深入探討這三個(gè)組件的工作原理和使用方法。

Serializers

在Django REST框架中，Serializers扮演著至關(guān)重要的角色。它們負(fù)責(zé)轉(zhuǎn)換復(fù)雜的數(shù)據(jù)類型，如Django模型實(shí)例或者復(fù)雜的查詢集，使得它們可以被渲染為像JSON或者XML這樣的可傳輸格式。同時(shí)，Serializers也負(fù)責(zé)在數(shù)據(jù)接收時(shí)完成反序列化的工作，將接收的數(shù)據(jù)轉(zhuǎn)換為Python數(shù)據(jù)類型。

什么是Serializer？

Serializer類似于Django的Form和ModelForm類，但它們不僅包含了簡(jiǎn)單的數(shù)據(jù)驗(yàn)證功能，還包含了復(fù)雜的類型轉(zhuǎn)換功能。它們可以對(duì)復(fù)雜的數(shù)據(jù)類型進(jìn)行序列化（轉(zhuǎn)換為Python基本數(shù)據(jù)類型），也可以對(duì)已序列化的數(shù)據(jù)進(jìn)行反序列化（轉(zhuǎn)換為復(fù)雜的數(shù)據(jù)類型）。

# serializers.py

from rest_framework import serializers
from .models import Book

class BookSerializer(serializers.ModelSerializer):
    class Meta:
        model = Book
        fields = ['id', 'title', 'author', 'published_date']

在上述例子中，BookSerializer就是一個(gè)Serializer，它繼承自ModelSerializer類，用于序列化和反序列化Book模型實(shí)例。

Serializers的工作原理

當(dāng)序列化對(duì)象時(shí)，Serializers首先將對(duì)象轉(zhuǎn)換為Python內(nèi)置的數(shù)據(jù)類型，然后再將這些數(shù)據(jù)類型轉(zhuǎn)換為可傳輸?shù)母袷?。反序列化時(shí)，Serializers會(huì)進(jìn)行相反的過程，先將接收的數(shù)據(jù)轉(zhuǎn)換為Python內(nèi)置的數(shù)據(jù)類型，然后再將這些數(shù)據(jù)類型轉(zhuǎn)換為復(fù)雜的數(shù)據(jù)類型。

以下是一個(gè)簡(jiǎn)單的例子，演示了如何使用BookSerializer進(jìn)行序列化和反序列化：

# 使用Serializer進(jìn)行序列化
book = Book.objects.get(id=1)
serializer = BookSerializer(book)
print(serializer.data)
# 輸出：{'id': 1, 'title': 'Django for Beginners', 'author': 'William S. Vincent', 'published_date': '2022-07-01'}
# 使用Serializer進(jìn)行反序列化
data = {'title': 'REST API with Django', 'author': 'William S. Vincent', 'published_date': '2023-07-01'}
serializer = BookSerializer(data=data)
if serializer.is_valid():
    book = serializer.save()
print(book)
# 輸出：<Book: REST API with Django>

Serializers的實(shí)例和使用

Serializers最常見的使用場(chǎng)景就是在視圖中，用于序列化和反序列化視圖處理的數(shù)據(jù)。

例如，我們可以在視圖中使用Serializer，來(lái)處理客戶端發(fā)來(lái)的POST請(qǐng)求，創(chuàng)建新的圖書：

# views.py

from rest_framework import status
from rest_framework.response import Response
from rest_framework.views import APIView
from .models import Book
from .serializers import BookSerializer

class BookList(APIView):
    def post(self, request):
        serializer = BookSerializer(data=request.data)
        if serializer.is_valid():
            book = serializer.save()
            return Response(serializer.data, status=status.HTTP_201_CREATED)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

在上述例子中，我們?cè)谝晥D的POST方法中使用了BookSerializer，將接收的數(shù)據(jù)反序列化為Book模型實(shí)例，并保存到數(shù)據(jù)庫(kù)中。

Serializers的使用非常廣泛，它們不僅可以用于基本的數(shù)據(jù)驗(yàn)證和轉(zhuǎn)換，還可以用于復(fù)雜的場(chǎng)景，如處理嵌套的數(shù)據(jù)、自定義字段、動(dòng)態(tài)字段等。在掌握了基本用法后，你可以根據(jù)你的需求，進(jìn)一步探索Serializers的各種高級(jí)用法。

ViewSets

在Django REST框架中，ViewSets是一個(gè)重要的組件，它提供了一種高級(jí)的視圖抽象，使我們能夠更方便地實(shí)現(xiàn)基于RESTful原則的API接口。

什么是ViewSet？

ViewSet可以看作是多個(gè)視圖的集合。在Django REST框架中，ViewSet類似于Django中的類視圖（Class-Based Views），但是它提供了更多的默認(rèn)行為和更廣泛的功能，比如默認(rèn)實(shí)現(xiàn)的GET、POST、PUT、PATCH和DELETE操作。

# views.py

from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer

在上述例子中，BookViewSet就是一個(gè)ViewSet。它繼承自ModelViewSet類，為Book模型實(shí)現(xiàn)了一整套的CRUD操作。

ViewSets的工作原理

ViewSet的工作原理與Django的類視圖非常相似。它將HTTP方法映射到ViewSet中的相應(yīng)方法，比如GET請(qǐng)求會(huì)映射到list或者retrieve方法，POST請(qǐng)求會(huì)映射到create方法，PUT和PATCH請(qǐng)求會(huì)映射到update方法，DELETE請(qǐng)求會(huì)映射到destroy方法。

以下是一個(gè)簡(jiǎn)單的例子，演示了如何使用BookViewSet處理GET和POST請(qǐng)求：

# 使用ViewSet處理GET請(qǐng)求
from rest_framework.test import APIRequestFactory

factory = APIRequestFactory()
request = factory.get('/books/')
response = BookViewSet.as_view({'get': 'list'})(request)
print(response.status_code)
# 輸出：200

# 使用ViewSet處理POST請(qǐng)求
request = factory.post('/books/', {'title': 'Django REST Framework', 'author': 'Tom Christie', 'published_date': '2023-07-01'})
response = BookViewSet.as_view({'post': 'create'})(request)
print(response.status_code)
# 輸出：201

ViewSets的實(shí)例和使用

ViewSet最常見的使用場(chǎng)景就是在URLconf中，用于為API接口創(chuàng)建URL路由。

例如，我們可以在URLconf中使用BookViewSet，來(lái)創(chuàng)建圖書API的URL路由：

# urls.py

from django.urls import include, path
from rest_framework.routers import DefaultRouter
from .views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

在上述例子中，我們?cè)赨RLconf中注冊(cè)了BookViewSet，Django REST框架會(huì)自動(dòng)為BookViewSet創(chuàng)建一套URL路由，對(duì)應(yīng)到其定義的各種操作。

ViewSet的使用非常靈活，它們不僅可以用于實(shí)現(xiàn)基本的CRUD操作，還可以用于實(shí)現(xiàn)復(fù)雜的邏輯，如權(quán)限控制、過濾、分頁(yè)等。在掌握了基本用法后，你可以根據(jù)你的需求，進(jìn)一步探索ViewSet的各種高級(jí)用法。

Routers

在 Django REST 框架中，Routers 為視圖集 (ViewSets) 提供了一種簡(jiǎn)潔的方式來(lái)創(chuàng)建和管理 URL 配置。使用 Routers，我們可以快速創(chuàng)建并配置 URL，減少重復(fù)的工作。

什么是Router？

Router 可以自動(dòng)地為視圖集創(chuàng)建 URL 配置，它為每個(gè)視圖集提供了一套標(biāo)準(zhǔn)的增刪改查（CRUD）操作的 URL 配置。Router 的使用可以極大地提高開發(fā)效率，避免了手動(dòng)創(chuàng)建每個(gè) URL 的繁瑣工作。

以下是一個(gè)簡(jiǎn)單的使用 Router 的例子：

# urls.py

from django.urls import include, path
from rest_framework.routers import DefaultRouter
from .views import BookViewSet

router = DefaultRouter()
router.register(r'books', BookViewSet)

urlpatterns = [
    path('', include(router.urls)),
]

在上述例子中，我們使用 DefaultRouter 創(chuàng)建了一個(gè) router，然后調(diào)用其 register 方法注冊(cè)了 BookViewSet。這會(huì)自動(dòng)為 BookViewSet 創(chuàng)建一套標(biāo)準(zhǔn)的 URL 配置。

Router 的工作原理

當(dāng)你向 Router 注冊(cè)一個(gè)視圖集時(shí)，Router 會(huì)自動(dòng)為這個(gè)視圖集創(chuàng)建一套 URL 配置。這套 URL 配置對(duì)應(yīng)到視圖集的各個(gè)方法，如 list、create、retrieve、update 和 destroy。

router = DefaultRouter()
router.register(r'books', BookViewSet)

在上述例子中，router 會(huì)為 BookViewSet 創(chuàng)建以下的 URL 配置：

• /books/：對(duì)應(yīng)到 BookViewSet 的 list 和 create 方法，分別處理 GET 和 POST 請(qǐng)求；
• /books/{pk}/：對(duì)應(yīng)到 BookViewSet 的 retrieve、update 和 destroy 方法，分別處理 GET、PUT/PATCH 和 DELETE 請(qǐng)求。

Router 的實(shí)例和使用

在 Django REST 框架中，有兩種常見的 Router：DefaultRouter 和 SimpleRouter。DefaultRouter 提供了一套包含額外的瀏覽器界面的路由配置，而 SimpleRouter 則提供了一套簡(jiǎn)單的基礎(chǔ)路由配置。

Router 的使用非常靈活，你可以根據(jù)需要注冊(cè)任意數(shù)量的視圖集，也可以在不同的 Django app 中使用不同的 Router。在掌握了基本用法后，你還可以深入研究如何自定義 Router，如自定義 URL 配置，自定義 URL 名稱等。

權(quán)限和認(rèn)證

在構(gòu)建API時(shí)，權(quán)限和認(rèn)證是非常重要的一環(huán)，它們決定了用戶能否訪問你的API以及用戶可以做什么。Django REST Framework提供了一套完善的權(quán)限和認(rèn)證系統(tǒng)，讓你可以輕松地控制用戶的訪問權(quán)限。

認(rèn)證

認(rèn)證是確定用戶身份的過程。Django REST Framework支持多種認(rèn)證方式，如SessionAuthentication、TokenAuthentication、BasicAuthentication等。

以下是如何在視圖中使用TokenAuthentication的示例：

# views.py

from rest_framework.authentication import TokenAuthentication
from rest_framework.permissions import IsAuthenticated
from rest_framework import viewsets
from .models import Book
from .serializers import BookSerializer

class BookViewSet(viewsets.ModelViewSet):
    queryset = Book.objects.all()
    serializer_class = BookSerializer
    authentication_classes = [TokenAuthentication]
    permission_classes = [IsAuthenticated]

在這個(gè)例子中，我們?yōu)锽ookViewSet設(shè)置了authentication_classes屬性，指定了使用TokenAuthentication。當(dāng)用戶請(qǐng)求BookViewSet時(shí)，Django REST Framework會(huì)檢查請(qǐng)求的HTTP頭部是否包含有效的令牌，以確定用戶的身份。

權(quán)限

權(quán)限是決定已經(jīng)認(rèn)證的用戶可以做什么的規(guī)則。Django REST Framework提供了多種權(quán)限管理方式，如IsAuthenticated、IsAdminUser、IsAuthenticatedOrReadOnly等。

在上述例子中，我們?yōu)锽ookViewSet設(shè)置了permission_classes屬性，指定了使用IsAuthenticated。這意味著只有認(rèn)證過的用戶才可以訪問BookViewSet。

自定義認(rèn)證和權(quán)限

除了使用Django REST Framework提供的認(rèn)證和權(quán)限管理方式，你還可以自定義認(rèn)證和權(quán)限。自定義認(rèn)證和權(quán)限可以讓你更靈活地控制用戶的訪問權(quán)限。

以下是一個(gè)自定義權(quán)限的例子，這個(gè)權(quán)限類只允許作者訪問他們自己的圖書：

# permissions.py

from rest_framework import permissions

class IsAuthor(permissions.BasePermission):
    def has_object_permission(self, request, view, obj):
        return obj.author == request.user

然后你可以在視圖中使用這個(gè)自定義權(quán)限：

# views.py

from .permissions import IsAuthor
# 其他導(dǎo)入...

class BookViewSet(viewsets.ModelViewSet):
    # 其他代碼...
    permission_classes = [IsAuthenticated, IsAuthor]

在這個(gè)例子中，IsAuthor權(quán)限類會(huì)對(duì)每個(gè)請(qǐng)求進(jìn)行檢查，如果請(qǐng)求的用戶不是圖書的作者，那么請(qǐng)求將被拒絕。

測(cè)試與調(diào)試

測(cè)試和調(diào)試是保證代碼質(zhì)量的重要步驟。Django REST Framework提供了一套用于測(cè)試和調(diào)試API的工具。

測(cè)試

Django REST Framework集成了Django的測(cè)試框架，并提供了一些額外的功能用于測(cè)試API。你可以使用Django REST Framework的APIClient類來(lái)模擬API請(qǐng)求，然后檢查響應(yīng)。

以下是一個(gè)測(cè)試示例：

# tests.py

from django.urls import reverse
from rest_framework import status
from rest_framework.test import APITestCase, APIClient
from .models import Book

class BookTests(APITestCase):
    def setUp(self):
        self.client = APIClient()
        self.book = Book.objects.create(title='Test Book', author='Test Author')

    def test_get_book(self):
        url = reverse('book-detail', kwargs={'pk': self.book.pk})
        response = self.client.get(url)
        self.assertEqual(response.status_code, status.HTTP_200_OK)
        self.assertEqual(response.data['title'], 'Test Book')
        self.assertEqual(response.data['author'], 'Test Author')

在這個(gè)例子中，我們首先在setUp方法中創(chuàng)建了一個(gè)APIClient和一個(gè)Book實(shí)例。然后，在test_get_book方法中，我們使用APIClient發(fā)出GET請(qǐng)求，然后檢查響應(yīng)的狀態(tài)碼和數(shù)據(jù)。

調(diào)試

Django REST Framework提供了一個(gè)瀏覽器界面用于調(diào)試API。你可以在瀏覽器中直接訪問API，查看響應(yīng)數(shù)據(jù)，或者發(fā)出POST、PUT、PATCH和DELETE請(qǐng)求。瀏覽器界面非常直觀，是調(diào)試API的好工具。

要使用瀏覽器界面，你只需要在settings.py中啟用它：

# settings.py

REST_FRAMEWORK = {
    'DEFAULT_RENDERER_CLASSES': [
        'rest_framework.renderers.BrowsableAPIRenderer',
        'rest_framework.renderers.JSONRenderer',
        # 其他渲染器...
    ]
}

在上述設(shè)置中，我們啟用了BrowsableAPIRenderer，這將啟用瀏覽器界面。你現(xiàn)在可以在瀏覽器中訪問API了。

使用工具進(jìn)行調(diào)試

有許多工具可以幫助你調(diào)試API，如Postman、Insomnia等。這些工具可以模擬各種HTTP請(qǐng)求，查看請(qǐng)求和響應(yīng)的詳細(xì)信息，以及保存和組織API請(qǐng)求。如果你需要進(jìn)行復(fù)雜的API調(diào)試，這些工具可能會(huì)很有幫助。

雖然測(cè)試和調(diào)試可能會(huì)花費(fèi)一些時(shí)間，但它們是保證代碼質(zhì)量的關(guān)鍵。在編寫代碼時(shí)，不要忘記寫測(cè)試和進(jìn)行調(diào)試。

總結(jié)

至此，我們對(duì)Django REST Framework進(jìn)行了一次深入的概覽。我們開始時(shí)介紹了Django REST Framework的基礎(chǔ)知識(shí)，然后深入學(xué)習(xí)了Serializers、ViewSets和Routers。我們還討論了權(quán)限和認(rèn)證系統(tǒng)，以及如何進(jìn)行測(cè)試和調(diào)試。

Django REST Framework提供了許多強(qiáng)大的工具，使得構(gòu)建復(fù)雜的API變得輕松。然而，掌握這些工具需要時(shí)間和實(shí)踐。我希望這篇文章能幫助你開始你的Django REST Framework之旅。

最后，我想重申一下我們?cè)谖恼轮杏懻摰囊恍╆P(guān)鍵點(diǎn)：

• Serializers用于數(shù)據(jù)序列化和反序列化。
• ViewSets是用于處理視圖邏輯的類。
• Routers負(fù)責(zé)URL的生成和分發(fā)。
• Django REST Framework提供了一套強(qiáng)大的權(quán)限和認(rèn)證系統(tǒng)。
• 你可以使用Django REST Framework的測(cè)試工具和調(diào)試界面來(lái)測(cè)試和調(diào)試你的API。

以上就是Django Rest Framework框架構(gòu)建復(fù)雜API技能詳解的詳細(xì)內(nèi)容，更多關(guān)于Django Rest Framework構(gòu)建API的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！

最新評(píng)論