rest_framework框架的認識

来源:https://www.cnblogs.com/695189322/archive/2022/08/06/16556490.html
-Advertisement-
Play Games

它是基於Django的，幫助我們快速開發符合RESTful規範的介面框架。 一 路由 可以通過路由as_view()傳參 根據請求方式的不同執行對應不同的方法 在routers模塊下 封裝了很多關於路由的方法 ， 最基礎的BaseRouter類，給我提供自定製的介面。 下麵這個方法給我們提供了自動生 ...



它是基於Django的，幫助我們快速開發符合RESTful規範的介面框架。

一  路由

　　可以通過路由as_view()傳參 根據請求方式的不同執行對應不同的方法

　　在routers模塊下 封裝了很多關於路由的方法 ， 最基礎的BaseRouter類，給我提供自定製的介面。

　　下麵這個方法給我們提供了自動生成兩條帶參數的url

複製代碼 
from rest_framework import routers
from django.conf.urls import url, include
from course.models import Course
from course.views import CourseView

routers = routers.DefaultRouter()
routers.register('Course', CourseView)

urlpatterns = [
    url(r'^', include(routers.urls)),

]
複製代碼

二  視圖

　　幫助開發者提供了一些類，併在類中提供了多種方法供我們使用，下圖是提供的主要的類以及繼承關係。

　 　提供其他一些視圖函數類，可以去源碼里看。

三   版本控制

　　下麵以URL上控製版本為例

　　1、添加配置

複製代碼 
REST_FRAMEWORK = {
    # 預設使用的版本控制類
    'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.URLPathVersioning',
    # 允許的版本
    'ALLOWED_VERSIONS': ['v1', 'v2'],
    # 版本使用的參數名稱
    'VERSION_PARAM': 'version',
    # 預設使用的版本
    'DEFAULT_VERSION': 'v1',
}
複製代碼

　　2、設置路由

urlpatterns = [
    #url(r'^admin/', admin.site.urls),
        url(r'^api/(?P<version>\w+)/', include('api.urls')),
]

　　3、獲取版本

　　  request.version 

四   認證

　　rest_framework給我們提供了認證的介面，由BaseAuthentication類提供介面，也有一些封裝好的認證類（請走入源碼....)

　　介面函數 authticate  認證成功返回一元組（user，token）分別賦值給request.user  和 request.auth

　　下麵是一個簡單的認證示例

複製代碼 
class Auth(BaseAuthentication):
    def authenticate(self, request):
        token = request.query_params.get('token')
        obj = models.Token.objects.filter(token=token).first()
        if not obj:
            raise AuthenticationFailed({'code': 1001, 'error': '認證失敗'})
        return (obj.user.username, obj)
複製代碼

　　我們的認證類可以放在局部視圖函數，也可以配置為全局認證。

# 局部視圖函數認證
class MyView(APIView):
    authentication_classes = [Auth]
    pass
# 全局配置 在settings.py
REST_FRAMEWORK = {
    'DEFAULT_AUTHENTICATION_CLASSES': [Auth],
}

五  許可權

　　由BasePermission類給我提供介面 介面函數為 has_permission  以及 has_object_permission

　　有許可權返回True 沒有則返回False，預設的許可權類為下圖。

複製代碼 
# 允許任何人訪問
class AllowAny(BasePermission):
    """
    Allow any access.
    This isn't strictly required, since you could use an empty
    permission_classes list, but it's useful because it makes the intention
    more explicit.
    """

    def has_permission(self, request, view):
        return True
複製代碼

　　介面類為下圖

複製代碼 
class BasePermission(object):
    """
    A base class from which all permission classes should inherit.
    """

    def has_permission(self, request, view):
        """
        Return `True` if permission is granted, `False` otherwise.
        """
        # 這裡寫我們的許可權邏輯
        return True

    def has_object_permission(self, request, view, obj):
        """
        Return `True` if permission is granted, `False` otherwise.
        """
        return True
複製代碼

　　還封裝了一些許可權類，只允許admin用戶訪問的許可權，只給認證的用戶許可權等等，請走源碼........

六  頻率

　　基礎的BaseThrottle類提供介面 介面函數為 allow_request，如果返回False則走wait

　　SimpleRateThrottle類給我們提供了get_cache_key介面，繼承這個類要寫rate(num_request, duration)多長時間內訪問次數

　　實現原理如下代碼：

複製代碼 
class SimpleRateThrottle(BaseThrottle):
    def allow_request(self, request, view):
        if self.rate is None:
            return True

        self.key = self.get_cache_key(request, view)
        if self.key is None:
            return True

        self.history = self.cache.get(self.key, [])
        self.now = self.timer()

       # 原理的實現邏輯
        while self.history and self.history[-1] <= self.now -self.duration:
            self.history.pop()
        if len(self.history) >= self.num_requests:
            return self.throttle_failure()
        return self.throttle_success()
複製代碼

　　這裡就放這些~~具體~請大家走入源碼.......

七   序列化

　　對queryset序列化以及對請求數據格式驗證。

　　通常繼承兩個類 Serializer 以及 ModelSerializer  

　　Serializer 序列化的每個欄位都要自己寫  ModelSerializer 會根據資料庫表渲染所有欄位 

　　註意sourse 以及 鉤子函數的應用 代碼如下：

複製代碼 
class CourseDetailModelSerializers(serializers.ModelSerializer):
    title = serializers.CharField(source='course.name')
    img = serializers.ImageField(source='course.course_img')
    level = serializers.CharField(source='course.get_level_display')
    recommends = serializers.SerializerMethodField()
    chapters = serializers.SerializerMethodField()

    def get_recommends(self, obj):
        queryset = obj.recommend_courses.all()
        return [{'id': row.id, 'title': row.name} for row in queryset]

    def get_chapters(self, obj):
        queryset = obj.course.course_chapters.all()
        return [{'id': row.id, 'name': row.name} for row in queryset]

    class Meta:
        model = CourseDetail
        fields = ['course', 'title', 'img', 'level', 'why_study', 'chapters', 'recommends']
複製代碼

 

八   分頁

　　對從資料庫中獲取到的數據進行分頁處理  SQL --> limit  offset

　　　　- 根據頁碼：http://www.myclass.com/api/v1/student/?page=1&size=10

　　　　- 根據索引：http://www.myclass.com/api/v1/student/?offset=60&limit=10

　　　　- 根據游標：http://www.myclass.com/api/v1/student/?page=erd8

　　頁碼越大速度越慢，為什麼怎麼解決？

　　　　- 原因：頁碼越大向後需要掃描的行數越多，因為每次都是從0開始掃描

　　　　- 解決：

　　　　　　- 限制當前顯示的頁數

　　　　　　- 記錄當前頁面數據ID的最大值和最小值，再次分頁時，根據ID進行篩選，在分頁

　　rest_framework 分頁的配置

　　　　-  全局分頁配置  

# settings.py 
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.LimitOffsetPagination',
    'PAGE_SIZE': 100
}

　　　　-  修改分頁風格

複製代碼 
class MyPagination(PageNumberPagination):
    page_size = 100
    page_size_query_param = 'page_size'
    max_page_size = 1000

# 然後在視圖中使用.pagination_class屬性調用該自定義類
class MyView(generics.ListAPIView):
    queryset = Billing.objects.all()
    serializer_class = BillingRecordsSerializer
    pagination_class = MyPagination

# 或者是在settings.py中修改DEFAULT_PAGINATION_CLASS

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'apps.core.pagination.MyPagination'
}
複製代碼

　　rest_framework給我提供的API

　　　 1、 PageNumberPagination

?
1 GET https://api.example.org/accounts/?page=4

　　　 響應對象　

複製代碼 
HTTP 200 OK
{
    "count": 1023
    "next": "https://api.example.org/accounts/?page=5",
    "previous": "https://api.example.org/accounts/?page=3",
    "results": [
       …
    ]
}
複製代碼

　　　配置屬性

　　　　- page_size  每頁顯示對象的數量 如果設置了就重寫PAGE_SIZE　　

　　　　- page_query_param  頁面查詢參數 指示分頁空間的查詢參數的名字

　　　　- page_size_query_param  允許客戶端根據每個請求設置頁面大小 一般都為None

　　　　- max_page_size  設置了page_size_query_param 才有意義 客戶端請求頁面中顯示最大數量

　　　　- last_page_strings 儲存page_query_param參數請求過的值列表或元組

　　2、LImitOffsetPagination

　　　　路由配置以及返回類型

複製代碼 
GET https://api.example.org/accounts/?limit=100&offset=400

HTTP 200 OK
{
    "count": 1023
    "next": "https://api.example.org/accounts/?limit=100&offset=500",
    "previous": "https://api.example.org/accounts/?limit=100&offset=300",
    "results": [
       …
    ]
}
複製代碼

　　　配置參數

　　　　- page_size  每頁顯示對象的數量 如果設置了就重寫PAGE_SIZE

　　　　- default_limit： 如果客戶端沒有提供，則預設使用與PAGE_SIZE值一樣。 

　　　　- limit_query_param：表示限制查詢參數的名字，預設為’limit’ 

　　　　- offset_query_param：表示偏移參數的名字， 預設為’offset’ 

　　　　- max_limit：允許頁面中顯示的最大數量，預設為None 

　　3、CursorPagination

　　　　- 基於游標的分頁顯示了一個不透明的“cursor”指示器，客戶端可以使用它來瀏覽結果集。

　　　　- 這種分頁方式只允許用戶向前或向後進行查詢。並且不允許客戶端導航到任意位置。

　　　　- 基於游標的分頁方式比較複雜，它要求結果集給出一個固定的順序，並且不允許客戶端任意的對結果集進行索引

　　　　全局配置如下

REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.CursorPagination',
    'PAGE_SIZE': 100
}

　　　　配置參數：

　　　　　　- page_size：顯示的最大條數 

　　　　　　- cursor_query_param： 游標查詢參數名，預設為’cursor’ 

　　　　　　- ordering： 排序欄位名的列表或者元組，例如ordering = ‘slug’，預設為-created 

　　4、自定義分頁

　　　　- 繼承pagination.BasePagination

　　　　- 重寫paginate_queryset(self, queryset, request, view=None)方法 ，

　　　　　　初始化queryset對象，設置pagination實例  返回一個包含用戶請求內容的可迭代對象 形成分頁對象

　　　　- 重寫get_paginated_response(self, data)方法

　　　　　　序列化請求頁中所包含的對象，返回一個Response對象

複製代碼 
class CustomPagination(pagination.PageNumberPagination):
    def get_paginated_response(self, data):
        return Response({
            'links': {
               'next': self.get_next_link(),
               'previous': self.get_previous_link()
            },
            'count': self.page.paginator.count,
            'results': data
        })

# 設置自定義分頁、
REST_FRAMEWORK = {
    'DEFAULT_PAGINATION_CLASS': 'my_project.apps.core.pagination.CustomPagination',
    'PAGE_SIZE': 100
}
複製代碼

九  解析器

　　預設的三個解析器 

　　　　- JsonParser  Json數據解析器

　　　　-  FormParser 和 MultiPartParser 一般同時使用

　　　　　　Both request.data will be populated with a QueryDict. 官方文檔的解釋

複製代碼 
DEFAULTS = {
    # rest_framework  settings.py
    'DEFAULT_PARSER_CLASSES': (
        'rest_framework.parsers.JSONParser',
        'rest_framework.parsers.FormParser',
        'rest_framework.parsers.MultiPartParser'
    ),
}
複製代碼

 

十   渲染器

　　預設的兩個渲染器，一個是Json的，一個是用瀏覽器訪問rest_framework自帶的模板的

複製代碼 
DEFAULTS = {
    # rest_framework   setting.py
    'DEFAULT_RENDERER_CLASSES': (
        'rest_framework.renderers.JSONRenderer',
        'rest_framework.renderers.BrowsableAPIRenderer',
    ),
}
複製代碼

 

 
您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • IOS OpenGL ES GPUImage 圖像加深混合 GPUImageDarkenBlendFilter
    目錄 一.簡介 二.效果演示 三.源碼下載 四.猜你喜歡 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 基礎 零基礎 OpenGL (ES) 學習路線推薦 : OpenGL (ES) 學習目錄 >> OpenGL ES 轉場 零基礎 O ...
  • 部署jar包windows服務工具
    背景 某個周末一個線上項目因為伺服器自動重啟導致了系統掛了，我們是通過jenkins部署的jar包所以需要手動重啟項目，解決問題後準備調換部署方式讓項目隨系統自動啟動，試用tomcat後發現啟動慢，並且日常開發springboot都是使用內置tomcat啟動，如果要保持和部署方式保持一致（避免本地代 ...
  • 那些捨不得刪除的 MP3--批量修改mp3的ID3tag
    1.七個網站的Python實戰代碼 1.汽車之家 def t1(): #汽車之家 ##請上傳JPG、JPEG、BMP格式圖片 import requests from requests_toolbelt import MultipartEncoder from bs4 import Beautifu ...
  • 12-Java中線程的狀態類型
    Java中線程的狀態類型 線程的狀態類型 源碼作者的原註釋關於線程內部類State描述了線程的六個狀態 A thread state. A thread can be in one of the following states: ①、NEW 尚未啟動的線程處於此狀態 源碼中的註釋 A thread ...
  • 後端編寫Swagger介面管理文檔
    Swagger介面管理文檔 訪問介面文檔的網頁：http://localhost:8080/swagger-ui/index.html 導入依賴 <dependency> <groupId>io.springfox</groupId> <artifactId>springfox-boot-start ...
  • Javaweb05-Ajax
    1、基於jQuery的Ajax 1.1 基本Ajax | 參數 | 說明 | | | | | url | 請求地址 | | type | 請求類型 | | data | 請求參數 | | dataType | 返回參數 | | success | 成功處理函數 | | error | 錯誤處理函數 ...
  • 【Java面試】這道互聯網高頻面試題難住了80%的程式員？索引什麼時候失效？
    “索引什麼時候失效？” 面試過程中，突如其來的一個問題，是不是有點懵？ 沒關係，關註我，面試不迷路。 我是Mic，一個工作了14年的Java程式員。 索引失效涉及到的知識點非常多，所以我把這個問題的回答整理到了一個20W字的面試文檔裡面，大家可以領取。 下麵看看高手的回答 高手： InnoDB引擎里 ...
  • django中資源文件夾的引入
    django中資源文件夾的引入 1.靜態資源文件夾的引入 settings.py的配置如下所示： # django預設配置 STATIC_URL='static/' # django會去應用裡面的static文件夾找靜態資源，僅當DEBUG為True時 # BASE_DIR是項目的絕對地址 STAT ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類