使用 Django Rest 架構建構 Django Rest API

Django Rest架構是一個強大的工具，可以幫助開發人員快速建構功能強大的Django RESTful API。在本篇文章中，我将向您介紹如何使用Django Rest架構建構一個簡單的Django Rest API。以下是建立Django Rest API的基本步驟：

第一步 - 安裝Django Rest架構：

1. 打開您的指令行界面。

2. 輸入以下指令來安裝Django Rest架構：

pip install djangorestframework           

第二步 - 建立Django項目：

1. 打開指令行界面，并導航到您要建立項目的目錄。

2. 輸入以下指令以建立一個新的Django項目：

django-admin startproject myproject           

第三步 - 建立Django應用程式：

1. 導航到您的Django項目目錄：

cd myproject           

2. 輸入以下指令以建立新的Django應用程式：

python manage.py startapp myapp           

這将建立一個名為"myapp"的新應用程式。

第四步 - 配置Django Rest架構：

1. 打開您的Django項目的settings.py檔案。

2. 在INSTALLED_APPS清單中添加'rest_framework'，以啟用Django Rest架構：

INSTALLED_APPS = [
    ...
    'rest_framework',
]           

3. 儲存并關閉settings.py檔案。

第五步 - 建立資料模型：

1. 打開myapp目錄下的models.py檔案。

2. 建立您希望在API中使用的資料模型。例如，讓我們建立一個簡單的"User"模型：

from django.db import models

class User(models.Model):
    name = models.CharField(max_length=100)
    email = models.EmailField()
    phone = models.CharField(max_length=15)           

3. 儲存并關閉models.py檔案。

第六步 - 建立序列化器：

1. 在myapp目錄下建立一個新的serializers.py檔案。

2. 在serializers.py檔案中編寫一個用于将資料模型序列化的序列化器。例如，在我們的例子中，我們希望将User模型序列化：

from rest_framework import serializers
from .models import User

class UserSerializer(serializers.ModelSerializer):
    class Meta:
        model = User
        fields = '__all__'           

這将自動生成一個用于User模型的序列化器。

第七步 - 建立API視圖：

1. 打開myapp目錄下的views.py檔案。

2. 編寫一個用于處理API請求的視圖。例如，在我們的例子中，我們将建立一個簡單的基于類的視圖：

from rest_framework import generics
from .models import User
from .serializers import UserSerializer

class UserListCreateView(generics.ListCreateAPIView):
    queryset = User.objects.all()
    serializer_class = UserSerializer           

這将建立一個視圖，允許我們列出和建立User對象。

第八步 - 配置URL路由：

1. 打開myproject目錄下的urls.py檔案。

2. 導入您在myapp中建立的視圖：

from django.urls import path

from myapp.views import UserListCreateView           

3. 添加您的URL路由到urlpatterns清單中：

urlpatterns = [

...

path('api/users/', UserListCreateView.as_view()),

]           

這将将您的API視圖映射到"/api/users/" URL。

第九步 - 運作服務

1. 在指令行中導航到您的Django項目根目錄。

2. 輸入以下指令以運作開發伺服器：

python manage.py runserver           

恭喜！您現在已經使用Django Rest架構成功建立了一個簡單的Django Rest API。您可以使用API端點"/api/users/"來檢視和建立使用者對象。記得在浏覽器中通路時，使用有效的URL來替代 "{localhost}"。

希望這篇文章對您有所幫助，并能激發您對技術的創造力。如果您有任何問題或需要進一步的幫助，請随時向我提問。加油！

AddOn: 如果您想了解更多python核心知識點

《Python Tricks》專欄是我最近在寫的一本針對Python開發人員的實用程式設計指南，涵蓋了Python中最強大和有用的特性和技巧。從基礎知識入手，深入介紹函數式程式設計、面向對象程式設計、并發程式設計、網絡程式設計、Web開發、資料處理和機器學習等内容。透徹解析Python語言特性，提供實踐案例和示例代碼，幫助您優雅解決各種問題。

如果您對python asyncio異步程式設計模型感興趣，可以關注我的《python asyncio從入門到精通》專欄。