資料結構
網路
關係型資料庫管理系統
作業系統
Java
MS Excel
iOS
HTML
CSS
Android
Python
C 程式設計
C++
C#
MongoDB
MySQL
Javascript
PHP
物理學
化學
生物學
數學
英語
經濟學
心理學
社會學
時尚研究
法律研究使用 Django 和 Python 構建 RESTful API
Python 和 Django 已成為 Web 開發領域的一對動態組合，使開發人員能夠建立健壯且可擴充套件的應用程式。Python 以其簡潔性和可讀性而聞名，提供了一種優雅的程式語言來構建各種應用程式。同時，Django 是一種用 Python 編寫的**高階 Web 框架**，提供了一個全面的工具包，用於快速開發和簡潔的設計。Python 和 Django 共同構成了一個強大的組合，使開發人員能夠高效且有效地構建 RESTful API。
在本教程中，我們將開始探索使用 Django 和 Python 構建 RESTful API 的過程。在本文中，我們將深入探討使用 Django 進行 API 開發的核心概念和最佳實踐。我們將涵蓋從設定新的 Django 專案到設計和實現 API 端點的所有內容。在本文的下一節中，我們將討論 API 版本控制、身份驗證和許可權等重要主題。
使用 Django 和 Python 構建 RESTful API
首先，我們需要設定一個新的 Django 專案。在終端或命令提示符中，導航到所需的目錄並執行以下命令
$ django-admin startproject myproject
這將在同名目錄中建立一個名為“myproject”的新 Django 專案。專案設定完成後，導航到專案目錄
$ cd myproject
接下來，我們將專門為我們的 API 建立一個 Django 應用程式。Django 中的應用程式是一個自包含的模組，表示專案特定功能。執行以下命令建立一個名為“api”的新應用程式
$ python manage.py startapp api
這將為我們的 API 生成必要的檔案和目錄。現在，我們可以在此應用程式中開始構建我們的 API。
現在我們已經對 Django 有了基本的瞭解，並且已經設定了我們的專案和應用程式，我們可以在本文的下一節中繼續設計我們的 API。
設計 API
首先，定義 API 的資源和端點非常重要。資源是 API 處理的實體或物件，例如使用者、帖子、評論等。端點表示客戶端可以透過這些 URL 與這些資源進行互動。例如，`/api/posts/` 可以是檢索所有帖子列表的端點。
要定義資源和端點，我們可以在 `api/views.py` 檔案中建立 Django 檢視。
from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Post
class PostListView(APIView):
def get(self, request):
posts = Post.objects.all()
# Serialize the posts and return the response
return Response(...)
在此示例中，我們定義了一個 `PostListView` 類，它繼承自 Django 的 `APIView`。`get()` 方法處理 GET 請求並使用 `Post` 模型從資料庫中檢索所有帖子。然後，我們可以序列化帖子並將響應返回給客戶端。
在本文的後續部分，我們將更深入地探討使用 Django 的檢視、序列化程式和路由系統實現 API 的過程。
實現 API
設計好 API 後，就可以使用 Django 來實現它了。在本節中，我們將學習如何建立 Django 檢視和序列化程式來處理 API 請求和響應。
要為 API 端點建立檢視，我們可以定義一個繼承自 Django 的 `APIView` 或其子類（例如 `GenericAPIView`）的類。在檢視類中，我們定義與不同 HTTP 方法相對應的方法，例如 `get()`、`post()`、`put()` 和 `delete()`。這些方法負責處理請求並返回響應。
例如，讓我們建立一個檢視來處理特定帖子的檢索
from rest_framework.views import APIView
from rest_framework.response import Response
from .models import Post
from .serializers import PostSerializer
class PostDetailView(APIView):
def get(self, request, pk):
post = Post.objects.get(pk=pk)
serializer = PostSerializer(post)
return Response(serializer.data)
在此示例中，我們定義了一個 `PostDetailView` 類，它繼承自 `APIView`。`get()` 方法接受一個額外的 `pk` 引數，該引數表示我們要檢索的帖子的主鍵。
Django 中的序列化程式提供了一種方便的方法，可以將複雜的資料型別（例如模型例項）轉換為 JSON 或其他可以輕鬆呈現和由客戶端使用的格式。序列化程式還處理反序列化，允許解析後的資料在首先驗證傳入資料後轉換回複雜型別。
要建立序列化程式，我們定義一個繼承自 `serializers.Serializer` 或其子類（例如 `serializers.ModelSerializer`）的類。在序列化程式類中，我們指定要包含的欄位和任何驗證規則。
繼續前面的示例，讓我們為 `Post` 模型建立一個序列化程式
from rest_framework import serializers
from .models import Post
class PostSerializer(serializers.ModelSerializer):
class Meta:
model = Post
fields = ['id', 'title', 'content', 'created_at']
在此示例中，我們定義了一個 `PostSerializer` 類，它繼承自 `ModelSerializer`。我們將 `Post` 模型指定為 `model` 屬性，並列出我們希望在序列化中包含的欄位。
Django 的路由系統在將 URL 對映到我們的 API 檢視中起著至關重要的作用。透過定義 URL 模式，我們可以確定如何路由請求以及哪個檢視應該處理它們。
例如，要將 `/api/posts/` URL 對映到我們的 `PostListView`（它檢索帖子列表），我們可以將以下程式碼新增到 `urls.py` 檔案中
from django.urls import path
from .views import PostListView
urlpatterns = [
path('api/posts/', PostListView.as_view()),
]
在此示例中，我們從 `django.urls` 中匯入 `path` 函式，並從我們的檢視中匯入 `PostListView`。我們使用 `path()` 函式定義一個 URL 模式，指定所需的 URL 並使用 `as_view()` 方法將其與 `PostListView` 檢視相關聯。
設定好檢視、序列化程式和路由後，我們現在可以為 API 資源實現 CRUD 操作。
例如，要為 Post 資源實現建立操作，我們可以修改我們的 PostListView 如下
from rest_framework import status
class PostListView(APIView):
def post(self, request):
serializer = PostSerializer(data=request.data)
if serializer.is_valid():
serializer.save()
return Response(serializer.data, status=status.HTTP_201_CREATED)
return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)
在此示例中，我們向 `PostListView` 添加了一個 `post()` 方法。我們使用請求資料初始化一個序列化程式，並使用 `is_valid()` 方法檢查它是否有效。如果有效，我們儲存序列化資料並將其作為響應返回，狀態為 201 已建立。如果無效，我們返回序列化程式錯誤，狀態為 400 錯誤請求。
結論
在本教程中，我們探討了使用 Django 和 Python 構建 RESTful API。我們設定了一個新的 Django 專案，透過定義資源和端點設計了 API，並實現了 CRUD 操作。我們建立了 Django 檢視和序列化程式來處理請求，並使用 Django 的路由系統將 URL 對映到檢視。我們還討論了 API 版本控制、身份驗證和許可權。藉助 Django 的 ORM，我們與資料庫互動，執行操作並利用模型關係。本教程為使用 Django 和 Python 構建強大的 RESTful API 提供了一個堅實的基礎。
249 次瀏覽
