2. 程式人生 > 其它 >01 drf入門規範

01 drf入門規範

阿新 • • 發佈：2022-04-15

一 Web應用是什麼

1. 通過瀏覽器訪問的應用程式都是Web應用

2. Web應用的模式：

C/S架構

c:client 客戶端 s:server 服務端

B/S架構

b:browser 瀏覽器 s:server 服務端

# 本質上b/s也是c/s

3. Web應用的優點：

- 1. 只需要一個瀏覽器 - 2. 節省客戶端資源 - 3. 只需要更新服務端，立馬影響客戶端

4. Web應用的缺點:

- 1. 谷歌瀏覽器，火狐瀏覽器，ie瀏覽器，360瀏覽器....... - 2. 服務端宕機，客戶端也立馬宕機，不能訪問

5. Web框架

在規定的位置，寫固定的程式碼

二 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引數值決定了響應資料的格式

    • 資料

      # 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請求

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

五 post請求的三種編碼方式

# 瀏覽器只能測試get請求的介面
# 通過postman工具可以測試任意個型別的請求方式：get，post，put，delete...
​
針對post請求的資料，編碼方式有3種：
    1. urlencoded
        在請求體中的格式：
            name=ly&age=18  => request.POST
    2. form-data
        # 上傳檔案
         # 普通資料
                name=ly&age=18  => request.POST
         # 檔案資料
            -----dsadsadsadsadsad-----
            file資料    =>   request.FILES
    3. json
        在請求體中的格式：
            {"name":"ly", "age":18}  # 它在請求中就是原樣
            
            '''
                在Django中如何獲取json格式的資料：
                    在request.POST中已經取不到值了，在request.body中取值
            '''
            # 針對request.body中的資料，需要自己處理
    
# form表單只能提交urlencoded, form-data, 不能提交json格式的資料
# <form action='' method='post' enctype='form-data'>
​
'''
    form上傳檔案：
        1. method='POST'
        2. enctype='form-data'
'''

六 RESTful API規範

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

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

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

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

6.1 資料的安全保障

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

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

6.2 介面特徵表現

6.3 多資料版本共存

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

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

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

6.7 響應狀態碼

6.7.1 正常響應

  • 響應狀態碼2xx

    • 200：常規請求

    • 201：建立成功

6.7.2 重定向響應

  • 響應狀態碼3xx

    • 301：永久重定向

    • 302：暫時重定向

6.7.3 客戶端異常

  • 響應狀態碼4xx

    • 403：請求無許可權

    • 404：請求路徑不存在

    • 405：請求方法不存在

5.7.4 伺服器異常

  • 響應狀態碼5xx

    • 500：伺服器異常

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

{
    error: "無許可權操作"
}

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

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

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

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

比較好的介面返回

# 響應資料要有狀態碼、狀態資訊以及資料本身
{
    "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）

9.1 安裝DRF

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

# mkvirtualenv drfdemo -p python3
# pip install django
​
pip install djangorestframework
pip install pymysql

9.1.1 建立django專案

cd ~/Desktop
django-admin startproject drfdemo

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

9.2 新增rest_framework應用

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

INSTALLED_APPS = [
    ...
    'rest_framework',
]

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

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

  • 操作資料庫

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

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

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

9.3.1. 建立模型操作類

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="個性簽名")

    class Meta:
        db_table="tb_student"
        verbose_name = "學生"
        verbose_name_plural = verbose_name

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

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

把students子應用新增到INSTALL_APPS中

初始化資料庫連線

安裝pymysql
pip install pymysql

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

import pymysql
pymysql.install_as_MySQLdb()

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

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",
    },
}

終端下，執行資料遷移。

python manage.py makemigrations
python manage.py migrate

錯誤列表

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

解決方案：

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

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

解決方法：

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

9.3.2. 建立序列化器

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

python manage.py startapp students

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

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

# 建立序列化器類，回頭會在試圖中被呼叫
class StudentModelSerializer(serializers.ModelSerializer):
    class Meta:
        model = Student
        fields = "__all__"

  • model 指明該序列化器處理的資料欄位從模型類BookInfo參考生成

  • fields 指明該序列化器包含模型類中的哪些欄位，’all‘指明包含所有欄位

9.3.3. 編寫檢視

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

from rest_framework.viewsets import ModelViewSet
from .models import Student
from .serializers import StudentModelSerializer
# Create your views here.
class StudentViewSet(ModelViewSet):
    queryset = Student.objects.all()
    serializer_class = StudentModelSerializer

  • queryset 指明該檢視集在查詢資料時使用的查詢集

  • serializer_class 指明該檢視在進行序列化或反序列化時使用的序列化器

9.3.4. 定義路由

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

from . import views
from rest_framework.routers import DefaultRouter

# 路由列表
urlpatterns = []

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

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

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

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

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

9.3.5. 執行測試

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

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原始碼分析

# 檢視層
from django.shortcuts import render, HttpResponse
from django.views import View
class CBVTest(View):
    # 通過排程(dispatch)分發請求
    def dispatch(self, request, *args, **kwargs):
        pass
        super().dispatch(request, *args, **kwargs)
        pass

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

    def post(self, request):
        return HttpResponse('cbv post method')
<!-- 模板層 -->
<form action="/cbv/" method="post">
    {% csrf_token %}
    <input type="text" name="usr">
    <button type="submit">提交</button>
</form>
# 路由層
from app import views
urlpatterns = [
    url(r'^cbv/', views.CBVTest.as_view()),
]

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

11.1 APIView的使用

# 1）安裝drf：pip3 install djangorestframework
# 2）settings.py註冊app：INSTALLED_APPS = [..., 'rest_framework']
# 3）基於cbv完成滿足RSSTful規範的介面
# 檢視層
from rest_framework.views import APIView
from rest_framework.response import Response
user_list = [{'id': 1, 'name': 'Bob'}, {'id': 2, 'name': 'Tom'}]
class Users(APIView):
    def get(self, request, *args, **kwargs):
        return Response({
            'status': 0,
            'msg': 'ok',
            'results': user_list
        })
    def post(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
        })
# 路由層
from app import views
urlpatterns = [
    url(r'^users/', views.Users.as_view()),
]

11.2 APIView和Request物件原始碼分析

11.2.1 APIView

# 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)

11.2.2 Request物件

 

相關推薦

01 drf入門規範

一 Web應用是什麼 1. 通過瀏覽器訪問的應用程式都是Web應用 2. Web應用的模式： C/S架構

drf入門規範

一. Web應用模式# 在開發Web應用中，有兩種應用模式： 知識儲備: 什麼是動態頁面（查資料庫的），什麼是靜態頁面（靜止的html）

01.scrapy入門

Scrapy快速入門 Scrapy是一個為了爬取網站資料，提取結構性資料而編寫的應用框架，它使用Twisted這個非同步網路庫來處理網路通訊，架構清晰，並且包含了各種中介軟體介面，可以靈活的完成各種需求。個人認為Scrapy是

入門規範

目錄入門規範1 web開發模式api介面postman的使用Restful規範（重點）drf的安裝和簡單使用補充

【Layui】01 快速入門

【原生JavaScript與 JQuery】 <!DOCTYPE html> <html lang=\"en\"> <head> <meta charset=\"UTF-8\">

【TypeScript】01 基礎入門

前提：使用TypeScript你需要安裝NodeJS支援 然後安裝TypeScript： npm intsall -g typescript

Vue3-01-TypeScript入門

1、TypeScript快速上手 1.1 初識 TypeScript TypeScript 的介紹 TypeScript是一種由微軟開發的開源、跨平臺的程式語言。它是JavaScript的超集，最終會被編譯為JavaScript程式碼。

django-rest-framework（drf入門）

django-rest-framework restful規範， drf入門，檢視，序列化（最重要）響應，許可權，認證頻率，過濾，分頁

Shiro-01-快速入門

Shiro Apache Shiro是一個強大且易用的Java安全框架,執行身份驗證、授權、密碼和會話管理。

01 快速入門

快速入門 官方連結：https://baomidou.com/guide/ 步驟 1、建立資料庫 2、建立表 建立專案 用SpringBoot初始化

01 Qt-入門

  1.Qt是什麼？ Qt（官方發音 [kju:t]，音同 cute）是一個跨平臺的 C++ 開發庫，主要用來開發圖形使用者介面（Graphical User Interface，GUI）程式，當然也可以開發不帶介面的命令列（Command User Interface，CUI

01-JavaSE入門、JDK的下載與安裝、第一個Java程式、Java程式的編譯與執行

01-JavaSE入門、JDK的下載與安裝、第一個Java程式、Java程式的編譯與執行 Java的發展歷史

Mybatis學習[01]：【介紹、入門程式編寫】

內容 1.Mybatis框架的介紹 2.入門程式的編寫 Mybatis框架的介紹  1. 軟體框架的含義：

01 . Shell詳細入門介紹及簡單應用

Shell簡介 Shell 是一個 C 語言編寫的指令碼語言，它是使用者與 Linux 的橋樑，使用者輸入命令交給 Shell 解釋處理Shell 將相應的操作傳遞給核心（Kernel），核心把處理的結果輸出顯示到螢幕給使用者.

Springboot入門-01

微服務階段 javaSE ： OOP Mysql: 持久化 html+css+js+jquery+框架: 檢視、框架不熟練、css不熟練。

Spring入門01

一、Spring簡單案例 1、搭建Spring基本專案 https://repo.spring.io/webapp/#/artifacts/browse/tree/General/libs-release-local/org/springframework/spring/5.1.3.RELEASE/spring-framework-5.1.3.RELEASE-dist.z

01.Spring5.x入門

第一章：Spring基礎 Spring概述 Spring 是一個開源的Java企業級應用開發框架。是一個分層的輕量級一站式(full-stack)框架，可以叫做家族型的框架，也可以叫做Spring全家桶。

Docker系列01—Docker 基礎入門

一、初識Docker和容器 1.1 什麼是docker 　　容納其他物品的工具，可以部分或完全封閉，被用於容納、儲存、運輸物品。物體可以被放置在容器中，而容器則可以保護內容物。

DRF 1 API介面規範

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

Liferay7 BPM門戶開發之2: BPMN 2.0 規範入門 （Activiti BPMN extensions）

Liferay最大的問題是BPM弱,如果做企業開發,BPM必不可少,所以直入主題,做個BPMN2入門.