python django中restful框架的使用

2021 年 6 月 21 日
筆記
django, Python

在使用django進行前後台分離開發時通常會搭配django-rest-framework框架創建RESTful風格的介面API。框架介紹及版本要求可參考官方地址：//www.django-rest-framework.org

本文以創建man包含name、sex欄位的API為實例學習django-rest-framework框架的使用。

主要包含下面5個步驟：

創建Django項目
創建ORM模型
載入Django REST Framework
序列化模型
創建載入數據的view和url

1.創建Django項目

創建django_rest

django-admin startproject django_rest

進入django_rest，創建虛擬環境env

virtualenv env

激活虛擬環境,並安裝django

source ./env/bin/activate

安裝 django

pip install django

創建rest_app

python manage.py startapp rest_app

註冊app，將app添加到INSTALLED_APPS

#setting.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_app'
]

創建後台admin賬戶用於管理

$ python manage.py createsuperuser

Username (leave blank to use 'root'):admin 
Email address: 
Password: 
Password (again): 
Superuser created successfully.

2.創建ORM模型

資料庫我們使用默認sqlite3 即可，如需要變更可在setting.py中databases配置。

修改我們/django_rest/models.py添加我們man的模型

#models.py

from django.db import models



# Create your models here.
class Man(models.Model):
    name = models.CharField(max_length=64)
    sex = models.CharField(max_length=64)

    def __str__(self):
        return self.name

做資料庫遷移

python manage.py makemigrations 
python manage.py migrate

將Man這個model註冊到我們的後台，以便可以通過django的後台做增刪查改，編寫admin.py如下

#admin.py
from django.contrib import admin
from .models import Man
# Register your models here.

admin.site.register(Man)  # 註冊Man到後台

啟動django服務

python manage.py runserver

訪問 //127.0.0.1:8000/admin/可以看到登錄介面，輸入密碼登錄

可以看到我們的rest_app下的模型man對象mans

我們添加一個那個男人lgd.ame

3. 載入Django REST Framework

安裝工具包

pip install djangorestframework

註冊rest_framework

#setting.py
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'rest_app'
    'rest_framework' #註冊
]

4.序列化模型

序列化器會把我們的模型數據轉化（序列化）為json格式，這樣就能夠被請求了。同樣當有josn數據提交過來的時候，序列化器會將json數據轉換為模型供咋們使用。

我們在rest_app下創建文件serializer.py

我們要做三件事：

導入Man模型
導入序REST Framework序列化器
創建新的類將模型和序列化器鏈接起來

from rest_framework import serializers

from .models import Man

class Manserializer(serializers.HyperlinkedModelSerializer):
    class Meta:
        model = Man
        fields = ('name','sex')

5.創建載入數據的view和url

我們需要把序列化後的數據返回給瀏覽器，所以要做一下步驟：

通過不通的Man查詢資料庫
將查詢後的數據傳遞給序列化器，通過序列化器轉化為json

我們在rest_app/views.py編寫我們的視圖,ModelViewSet由rest_framework提供，包含了get、post方法

# views.py
from rest_framework import viewsets

from .serializers import ManSerializer
from .models import Man


class ManViewSet(viewsets.ModelViewSet):
    queryset = Man.objects.all().order_by('name')  #查詢結果給queryset
    serializer_class = ManSerializer     #對結果進序列化

在django_rest目錄下urls.py添加api路由

from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('admin/', admin.site.urls),
    path('', include('rest_app.urls')),
 ]

在rest_app目錄下創建urls.py添加視圖路由，通過rest_framework中router確保我們的請求到正確的動態資源。

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

router = routers.DefaultRouter()
router.register(r'man', views.ManViewSet)   #路由到ManViewSet視圖

# Wire up our API using automatic URL routing.
# Additionally, we include login URLs for the browsable API.
urlpatterns = [
    path('', include(router.urls)), #使用router路由
    path('api-auth/', include('rest_framework.urls', namespace='rest_framework'))
]

最後我們來啟動服務,訪問//127.0.0.1:8000/ 可以在瀏覽器查看到我們api資訊

python manage.py runserver

訪問//127.0.0.1:8000/man/ 來查看man資源

通過id來訪問api資源//127.0.0.1:8000/man/1/

這樣我們一個基礎restful風格的API創建完成了。感覺關鍵點還是理解ModelViewSet和內置router不讀源碼很難知其所以然。

文章有不足的地方歡迎在評論區指出。

歡迎收藏、點贊、提問。關注頂級飲水機管理員，除了管燒熱水，有時還做點別的。

Tags: django Python