2. 程式人生 > 實用技巧 >drf之restful規範

drf之restful規範

阿新 • • 發佈：2020-12-28

一 Web應用模式

在開發Web應用中，有兩種應用模式：

1.1 前後端不分離

1.2 前後端分離

二 API介面

為了在團隊內部形成共識、防止個人習慣差異引起的混亂，我們需要找到一種大家都覺得很好的介面實現規範，而且這種規範能夠讓後端寫的介面，用途一目瞭然，減少雙方之間的合作成本。

通過網路，規定了前後臺資訊互動規則的url連結，也就是前後臺資訊互動的媒介

Web API介面和一般的url連結還是有區別的，Web API介面簡單概括有下面四大特點

  • url：長得像返回資料的url連結

  • 請求方式：get、post、put、patch、delete

    • 採用get方式請求上方介面

  • 請求引數：json或xml格式的key-value型別資料

    • ak：6E823f587c95f0148c19993539b99295
    • region：上海
    • query：肯德基
    • output：json

  • 響應結果：json或xml格式的資料

    • 上方請求引數的output引數值決定了響應資料的格式

    • 資料

      1
      2
      3
      4
      5
      6
      7
      8
      9
      10
      11
      12
      13
      14
      15
      16
      17
      18
      19
      20
      21
      22
      23
      24
      25
      26
      		 
      # xml格式
      https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=xml
       

      #json格式
      https://api.map.baidu.com/place/v2/search?ak=6E823f587c95f0148c19993539b99295&region=%E4%B8%8A%E6%B5%B7&query=%E8%82%AF%E5%BE%B7%E5%9F%BA&output=json
      {
      "status":0,
      "message":"ok",
      "results":[
              {
      "name":"肯德基(羅餐廳)",
      "location":{
      "lat":31.415354,
      "lng":121.357339
                  },
      "address":"月羅路2380號"
       
      ,
      "province":"上海市",
      "city":"上海市",
      "area":"寶山區",
      "street_id":"339ed41ae1d6dc320a5cb37c",
      "telephone":"(021)56761006",
      "detail":1,
      "uid":"339ed41ae1d6dc320a5cb37c"
              }
            	...
      		]
      }

三 介面測試工具：Postman

Postman是一款介面除錯工具，是一款免費的視覺化軟體，同時支援各種作業系統平臺，是測試介面的首選工具。

Postman可以直接從官網：https://www.getpostman.com/downloads/下載獲得，然後進行傻瓜式安裝。

  • 工作面板

  • 簡易的get請求

  • 簡易的post請求

  • 案例：請求百度地圖介面

四 RESTful API規範

REST全稱是Representational State Transfer，中文意思是表述（編者注：通常譯為表徵性狀態轉移）。 它首次出現在2000年Roy Fielding的博士論文中。

RESTful是一種定義Web API介面的設計風格，尤其適用於前後端分離的應用模式中。

這種風格的理念認為後端開發任務就是提供資料的，對外提供的是資料資源的訪問介面，所以在定義介面時，客戶端訪問的URL路徑就表示這種要操作的資料資源。

事實上，我們可以使用任何一個框架都可以實現符合restful規範的API介面。

4.1 資料的安全保障

  • url連結一般都採用https協議進行傳輸

    注：採用https協議，可以提高資料互動過程中的安全性

4.2 介面特徵表現

4.3 多資料版本共存

4.4 資料即是資源，均使用名詞（可複數）

4.5 資源操作由請求方式決定（method）

4.6 過濾，通過在url上傳參的形式傳遞搜尋條件

4.7 響應狀態碼

4.7.1 正常響應

  • 響應狀態碼2xx
    • 200：常規請求
    • 201：建立成功

4.7.2 重定向響應

  • 響應狀態碼3xx
    • 301：永久重定向
    • 302：暫時重定向

4.7.3 客戶端異常

  • 響應狀態碼4xx
    • 403：請求無許可權
    • 404：請求路徑不存在
    • 405：請求方法不存在

4.7.4 伺服器異常

  • 響應狀態碼5xx
    • 500：伺服器異常

4.8 錯誤處理，應返回錯誤資訊，error當做key

1
2
3
 
{
    error: "無許可權操作"
}

4.9 返回結果，針對不同操作，伺服器向用戶返回的結果應該符合以下規範

1
2
3
4
5
6
 
GET /collection：返回資源物件的列表（陣列）
GET /collection/resource：返回單個資源物件
POST /collection：返回新生成的資源物件
PUT /collection/resource：返回完整的資源物件
PATCH /collection/resource：返回完整的資源物件
DELETE /collection/resource：返回一個空文件

4.10 需要url請求的資源需要訪問資源的請求連結

1
2
3
4
5
6
7
8
9
10
11
12
 
# Hypermedia API，RESTful API最好做到Hypermedia，即返回結果中提供連結，連向其他API方法，使得使用者不查文件，也知道下一步應該做什麼
{
"status": 0,
"msg": "ok",
"results":[
        {
"name":"肯德基(羅餐廳)",
"img": "https://image.baidu.com/kfc/001.png"
        }
      	...
		]
}

比較好的介面返回

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
 
# 響應資料要有狀態碼、狀態資訊以及資料本身
{
"status": 0,
"msg": "ok",
"results":[
        {
"name":"肯德基(羅餐廳)",
"location":{
"lat":31.415354,
"lng":121.357339
            },
"address":"月羅路2380號",
"province":"上海市",
"city":"上海市",
"area":"寶山區",
"street_id":"339ed41ae1d6dc320a5cb37c",
"telephone":"(021)56761006",
"detail":1,
"uid":"339ed41ae1d6dc320a5cb37c"
        }
      	...
		]
}

四 序列化

api介面開發，最核心最常見的一個過程就是序列化，所謂序列化就是把資料轉換格式，序列化可以分兩個階段：

序列化： 把我們識別的資料轉換成指定的格式提供給別人。

例如：我們在django中獲取到的資料預設是模型物件，但是模型物件資料無法直接提供給前端或別的平臺使用，所以我們需要把資料進行序列化，變成字串或者json資料，提供給別人。

反序列化：把別人提供的資料轉換/還原成我們需要的格式。

例如：前端js提供過來的json資料，對於python而言就是字串，我們需要進行反序列化換成模型類物件，這樣我們才能把資料儲存到資料庫中。

五 Django Rest_Framework

核心思想: 縮減編寫api介面的程式碼

Django REST framework是一個建立在Django基礎之上的Web 應用開發框架，可以快速的開發REST API介面應用。在REST framework中，提供了序列化器Serialzier的定義，可以幫助我們簡化序列化與反序列化的過程，不僅如此，還提供豐富的類檢視、擴充套件類、檢視集來簡化檢視的編寫工作。REST framework還提供了認證、許可權、限流、過濾、分頁、介面文件等功能支援。REST framework提供了一個API 的Web視覺化介面來方便檢視測試介面。

官方文件：https://www.django-rest-framework.org/

github: https://github.com/encode/django-rest-framework/tree/master

特點

  • 提供了定義序列化器Serializer的方法，可以快速根據 Django ORM 或者其它庫自動序列化/反序列化；
  • 提供了豐富的類檢視、Mixin擴充套件類，簡化檢視的編寫；
  • 豐富的定製層級：函式檢視、類檢視、檢視集合到自動生成 API，滿足各種需要；
  • 多種身份認證和許可權認證方式的支援；[jwt]
  • 內建了限流系統；
  • 直觀的 API web 介面；
  • 可擴充套件性，外掛豐富

六 環境安裝與配置

DRF需要以下依賴：

  • Python (2.7, 3.2, 3.3, 3.4, 3.5, 3.6)
  • Django (1.10, 1.11, 2.0)

DRF是以Django擴充套件應用的方式提供的，所以我們可以直接利用已有的Django環境而無需從新建立。（若沒有Django環境，需要先建立環境安裝Django）

6.1 安裝DRF

前提是已經安裝了django，建議安裝在虛擬環境

1
2
3
4
5
 
# mkvirtualenv drfdemo -p python3
# pip install django

pip install djangorestframework
pip install pymysql

6.1.1 建立django專案

1
2
 
cd ~/Desktop
django-admin startproject drfdemo

使用pycharm開啟專案，設定虛擬環境的解析器，並修改manage.py中的字尾引數。

6.2 新增rest_framework應用

在settings.py的INSTALLED_APPS中新增’rest_framework’。

1
2
3
4
 
INSTALLED_APPS = [
    ...
    'rest_framework',
]

接下來就可以使用DRF提供的功能進行api介面開發了。在專案中如果使用rest_framework框架實現API介面，主要有以下三個步驟：

  • 將請求的資料（如JSON格式）轉換為模型類物件
  • 操作資料庫
  • 將模型類物件轉換為響應的資料（如JSON格式）

接下來，我們快速體驗下四天後我們學習完成drf以後的開發程式碼。接下來程式碼不需要理解，看步驟。

6.3 體驗drf完全簡寫程式碼的過程（瞭解）

6.3.1. 建立模型操作類

1
2
3
4
5
6
7
8
9
10
11
12
 
class Student(models.Model):
    # 模型欄位
    name = models.CharField(max_length=100,verbose_name="姓名")
    sex = models.BooleanField(default=1,verbose_name="性別")
    age = models.IntegerField(verbose_name="年齡")
    class_null = models.CharField(max_length=5,verbose_name="班級編號")
    description = models.TextField(max_length=1000,verbose_name="個性簽名")

classMeta:
        db_table="tb_student"
        verbose_name = "學生"
        verbose_name_plural = verbose_name

為了方便測試，所以我們可以先建立一個數據庫。

1
 
create database students charset=utf8;
6.3.1.1 執行資料遷移

把students子應用新增到INSTALL_APPS中

初始化資料庫連線

1
2
 
安裝pymysql
pip install pymysql

主引用中__init__.py設定使用pymysql作為資料庫驅動

1
2
3
 
import pymysql

pymysql.install_as_MySQLdb()

settings.py配置檔案中設定mysql的賬號密碼

1
2
3
4
5
6
7
8
9
10
11
12
13
14
 
DATABASES = {
    # 'default': {
    #     'ENGINE': 'django.db.backends.sqlite3',
    #     'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
    # },
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': "students",
        "HOST": "127.0.0.1",
        "PORT": 3306,
        "USER": "root",
        "PASSWORD":"123",
    },
}

終端下，執行資料遷移。

1
2
 
python manage.py makemigrations
python manage.py migrate

錯誤列表

1
 
# 執行資料遷移 python manage.py makemigrations 報錯如下：

解決方案：

1
 
註釋掉 backends/mysql/base.py中的35和36行程式碼。
 

1
 
# 執行資料遷移發生以下錯誤：

解決方法：

backends/mysql/operations.py146行裡面新增一個行程式碼：

6.3.2. 建立序列化器

例如，在django專案中建立學生子應用。

1
 
python manage.py startapp students

在syudents應用目錄中新建serializers.py用於儲存該應用的序列化器。

建立一個StudentModelSerializer用於序列化與反序列化。

1
2
3
4
5
 
# 建立序列化器類，回頭會在試圖中被呼叫
classStudentModelSerializer(serializers.ModelSerializer):
classMeta:
        model = Student
        fields = "__all__"
  • model 指明該序列化器處理的資料欄位從模型類BookInfo參考生成
  • fields 指明該序列化器包含模型類中的哪些欄位，’all‘指明包含所有欄位

6.3.3. 編寫檢視

在students應用的views.py中建立檢視StudentViewSet，這是一個檢視集合。

1
2
3
4
5
6
7
 
from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
classStudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer
  • queryset 指明該檢視集在查詢資料時使用的查詢集
  • serializer_class 指明該檢視在進行序列化或反序列化時使用的序列化器

6.3.4. 定義路由

在students應用的urls.py中定義路由資訊。

1
2
3
4
5
6
7
8
9
10
 
from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

router = DefaultRouter()  # 可以處理檢視的路由器
router.register('students', views.StudentViewSet)  # 向路由器中註冊檢視集

urlpatterns += router.urls  # 將路由器中的所以路由資訊追到到django的路由列表中

最後把students子應用中的路由檔案載入到總路由檔案中.

1
2
3
4
5
6
7
 
from django.contrib import admin
from django.urls import path,include

urlpatterns = [
    path('admin/', admin.site.urls),
    path("stu/",include("students.urls")),
]

6.3.5. 執行測試

運行當前程式（與執行Django一樣）

1
 
python manage.py runserver

在瀏覽器中輸入網址127.0.0.1:8000，可以看到DRF提供的API Web瀏覽頁面：

1）點選連結127.0.0.1:8000/stu/students 可以訪問獲取所有資料的介面，呈現如下頁面：

2）在頁面底下表單部分填寫學生資訊，可以訪問新增新學生的介面，儲存學生資訊：

點選POST後，返回如下頁面資訊：

3）在瀏覽器中輸入網址127.0.0.1:8000/stu/students/5/，可以訪問獲取單一學生資訊的介面（id為5的學生），呈現如下頁面：

4）在頁面底部表單中填寫學生資訊，可以訪問修改學生的介面：

點選PUT，返回如下頁面資訊：

5）點選DELETE按鈕，可以訪問刪除學生的介面：

返回，如下頁面：

七 CBV原始碼分析

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
# 檢視層
from django.shortcuts import render, HttpResponse
from django.views import View
classCBVTest(View):
# 通過排程(dispatch)分發請求
defdispatch(self, request, *args, **kwargs):
pass
        super().dispatch(request, *args, **kwargs)
pass

defget(self, request):
return render(request, 'cbv.html')

defpost(self, request):
return HttpResponse('cbv post method')
 
1
2
3
4
5
6
 
<!-- 模板層 -->
<formaction="/cbv/"method="post">
    {% csrf_token %}
    <inputtype="text"name="usr">
    <buttontype="submit">提交</button>
</form>
 
1
2
3
4
5
 
# 路由層
from app import views
urlpatterns = [
    url(r'^cbv/', views.CBVTest.as_view()),
]

八 drf基本使用及request原始碼分析

8.1 APIView的使用

1
2
3
 
# 1）安裝drf：pip3 install djangorestframework
# 2）settings.py註冊app：INSTALLED_APPS = [..., 'rest_framework']
# 3）基於cbv完成滿足RSSTful規範的介面
 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# 檢視層
from rest_framework.views import APIView
from rest_framework.response import Response
user_list = [{'id': 1, 'name': 'Bob'}, {'id': 2, 'name': 'Tom'}]
classUsers(APIView):
defget(self, request, *args, **kwargs):
return Response({
'status': 0,
'msg': 'ok',
'results': user_list
        })
defpost(self, request, *args, **kwargs):
# request對formdata，urlencoded，json三個格式引數均能解析
        name = request.data.get('name')
        id = len(user_list) + 1
        user = {'id': id, 'name': name}
        user_list.append(user)
return Response({
'status': '0',
'msg': 'ok',
'results': user
        })
 
1
2
3
4
5
 
# 路由層
from app import views
urlpatterns = [
    url(r'^users/', views.Users.as_view()),
]

8.2 APIView和Request物件原始碼分析

8.2.1 APIView

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
 
# as_view()
# 核心走了父類as_view
	view = super(APIView, cls).as_view(**initkwargs)
# 返回的是區域性禁用csrf認證的view檢視函式
return csrf_exempt(view)

# dispatch(self, request, *args, **kwargs)
# 二次封裝request物件
	request = self.initialize_request(request, *args, **kwargs)
# 自定義request規則
    self.initial(request, *args, **kwargs)

# initialize_request(self, request, *args, **kwargs)
# 原生request封裝在request._request

# initial(self, request, *args, **kwargs)
# 認證
	self.perform_authentication(request)
# 許可權
    self.check_permissions(request)
# 頻率
    self.check_throttles(request)

8.2.2 Request物件

相關推薦

drf之restful規範

一 Web應用模式 在開發Web應用中，有兩種應用模式： 1.1 前後端不分離 1.2 前後端分離

Django框架之drf 之一 [restful規範 APIview原始碼分析 Request類分析 序列化元件 ]

Django框架drf之 restful規範 APIview原始碼分析 Request類分析 序列化元件 一、restful規範

restful規範 之 CBV 實現介面流程梳理

一、CBV實現demo程式碼展示 1、urls.py urlpatterns = [ path(\'admin/\', admin.site.urls), re_path(r\'^Students/$\',views.StudentView.as_view()),

drf API介面 restful規範

內容概要 web應用模式 API介面 介面測試工具postman restful規範 內容詳細 web應用模式

RESTful規範Api最佳設計實踐

RESTful是目前比較流行的介面路徑設計規範，基於HTTP，一般使用JSON方式定義，通過不同HttpMethod來定義對應介面的資源動作，如：新增（POST）、刪除（DELETE）、更新（PUT、PATCH）、查詢（GET）等。

drf之序列化元件(一)：Serializer

序列化元件：Serializer、ModelSerializer、ListModelSerializer Serializer 偏底層ModelSerializer 重點ListModelSerializer 輔助群改

drf之檢視基類與擴充套件類

drf之檢視基類與擴充套件類 Django REST framwork 提供的檢視的主要作用： 控制序列化器的執行（檢驗、儲存、轉換資料）

drf之過濾與排序

一、過濾 　　1、需要另外安裝django的過濾模組：pip install django-filter。 　　2、需要在setting.py中註冊。

drf之分頁器

一、簡介：drf內建了三種分頁器類，一般需要重寫類繼承預設的分頁器類來定製屬性的具體數值。

DRF之文件生成和JWT

目錄1 自定製頻率2 自動生成介面文件3 JWT3.1 自定製auth認證類3.2 控制使用者登入後才能訪問，和不登入就能訪問3.3 控制登入介面返回的資料格式3.4 自定義基於jwt的許可權類3.5 手動簽發token（多方式登入）3.6 jwt

DRF之RBAC和django快取的使用

1 基於角色的許可權控制（django內建auth體系） # RBAC :是基於角色的訪問控制（Role-Based Access Control）即公司內部系統

drf之jwt傻瓜式啟動說明書

DRF之jwt使用說明書 jwt介紹 JsonWebToken 如何獲取token 先建立一張使用者表，要想使用jwt，必須使用django自帶的使用者表

DRF之JWT補充

DRF之JWT補充 1.JWT控制使用者登入後才能反問，匿名使用者無法訪問 class QueryUserView(GenericViewSet, RetrieveModelMixin):

drf之認證、許可權、頻率

Author：Laoqi 目錄1、認證1.1 認證類的構建1.2 認證類的使用2 許可權2.1 許可權類的構建2.2 許可權類的使用2.3 drf內建的許可權類3 頻率3.1 頻率類的構建3.2 頻率類的使用3.3 df內建的頻率限制類4 過濾與排序4.1

Python學習————RESTful規範

RESTful規範 一、什麼是RESTful REST與技術無關，代表的是一種軟體架構風格，REST是Representational State Transfer的簡稱，中文翻譯為“表徵狀態轉移”

小談DRF之許可權相關

2. 許可權 先丟擲一個問題：不同的檢視不同的許可權可以訪問。比如：訂單相關檢視只允許SVIP才能訪問。

前端編碼風格規範之 HTML 規範

HTML 規範 文件型別 推薦使用 HTML5 的文件型別申明：<!DOCTYPE html>. （建議使用 text/html 格式的 HTML。避免使用 XHTML。XHTML 以及它的屬性，比如application/xhtml+xml在瀏覽器中的應用支援與優化空間都

drf之序列化元件

序列化元件： 1. 序列化,序列化器會把模型物件轉換成字典,經過response以後變成json字串2. 反序列化,把客戶端傳送過來的資料,經過request以後變成字典,序列化器可以把字典轉成模型3. 反序列化,完成資料校驗功能

drf之檢視元件

兩個檢視基類APIView、GenericAPIView 1、APIView類： APIView是REST framework提供的所有檢視的基類，繼承自Django的View父類。

drf 之 JWT認證 什麼是叢集以及分散式 什麼是正向代理，什麼是反向代理

JWT認證 什麼是JWT認證： Json web token(ＪＷＴ)，是為了在網路應用環境間傳遞宣告而執行的一種基於JSON的開放標準（(RFC 7519).該token被設計為緊湊且安全的，特別適用於分散式站點的單點登入（SSO）場景。JWT的宣