Django-rest framework框架的安裝配置和簡介、Restful接口規範、基於原生django書寫知足restful規範的接口

Django-rest framework框架的安裝配置、簡介、Restful接口規範、基於原生django書寫知足restful規範的接口

drf框架安裝配置

一.安裝

pip3 install djangorestframework

二.配置

# 註冊drf app INSTALLED_APPS = [ # ... 'rest_framework', ]

三.特色

# 具體功能在具體模塊下 from rest_framework.request import Request from rest_framework.response import Response from rest_framework.exceptions import APIException from rest_framework.filters import OrderingFilter from rest_framework.views import APIView from rest_framework.pagination import PageNumberPagination from rest_framework.settings import APISettings # 自定義drf配置 - 在本身的settings.py REST_FRAMEWORK = { # 自定義修改drf的配置們 }

什麼是drf框架

1、drf優勢

1. Django-rest framework能夠幫助咱們簡化如下兩部分的代碼編寫，大大提升REST API的開發速度。

• 在序列化與反序列化時，雖然操做的數據不盡相同，可是執行的過程倒是類似的，也就是說這部分代碼是能夠複用簡化編寫的。
• 在開發REST API的視圖中，雖然每一個視圖具體操做的數據不一樣，但增、刪、改、查的實現流程基本套路化，因此這部分代碼也是能夠複用簡化編寫的。
  • 增：校驗請求數據 -> 執行反序列化過程 -> 保存數據庫 -> 將保存的對象序列化並返回
  • 刪：判斷要刪除的數據是否存在 -> 執行數據庫刪除
  • 改：判斷要修改的數據是否存在 -> 校驗請求的數據 -> 執行反序列化過程 -> 保存數據庫 -> 將保存的對象序列化並返回
  • 查：查詢數據庫 -> 將數據序列化並返回

2. Django REST framework 框架是一個用於構建Web API 的強大而又靈活的工具。一般簡稱爲DRF框架或REST framework。

3. DRF框架是創建在Django框架基礎之上，由Tom Christie大牛二次開發的開源項目。

2、特色

• 提供了定義序列化器Serializer的方法，能夠快速根據 Django ORM 或者其它庫自動序列化/反序列化；
• 提供了豐富的類視圖、Mixin擴展類，簡化視圖的編寫；
• 豐富的定製層級：函數視圖、類視圖、視圖集合到自動生成 API，知足各類須要；
• 多種身份認證和權限認證方式的支持；
• 內置了限流系統；
• 直觀的 API web 界面；
• 可擴展性，插件豐富

drf框架的做用

做用：寫接口

什麼是接口：

URL（先後臺信息交互的媒介）

明確了請求方式，提供對應後臺所需參數，請求url連接能夠獲得後臺的相應數據

怎麼寫接口：

參照某種規則（規範）書寫url連接，同時根據規則制定請求方式，數據與響應結果。

接口文檔：

提供給先後臺開發人員與測試人員查看

接口規範：

webapi接口規範：restful

URL設計

請求方式

數據的安全保障

利用https協議

接口特徵表現的兩種方式

• https://api.baidu.com
• https://www.baidu.com/api

注：看到api字眼，就表明該請求url連接是完成先後臺數據交互的

多數據版本共存

• https://api.baidu.com/v1
• https://api.baidu.com/v2

注：url連接中的v一、v2就是不一樣數據版本的提現（只有在一種數據資源有多版本的狀況下）

數據即資源

接口通常都是完成先後臺數據的交互，交互數據就稱之爲資源

eg：https://api.baidu.com/books

注：通常提倡用資源的複數形式，不要出現操做資源的動詞

資源操做由請求方式決定

操做資源通常都會涉及到增刪改查，咱們提供請求方式來標識增刪改查動做,eg:

''' https://api.baidu.com/books - get請求：獲取全部書 https://api.baidu.com/books/1 - get請求：獲取主鍵爲1的書 https://api.baidu.com/books - post請求：新增一本書書 https://api.baidu.com/books/1 - put請求：總體修改主鍵爲1的書 https://api.baidu.com/books/1 - patch請求：局部修改主鍵爲1的書 https://api.baidu.com/books/1 - delete請求：刪除主鍵爲1的書 '''

響應狀態碼

200：常規請求

201：建立成功

301：永久重定向

302：暫時重定向

403：請求無權限

404：請求路徑不存在

405：請求方法不存在

500：服務器異常

響應結果

響應數據要有狀態碼、狀態信息以及數據自己

}
"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" } ... ] }

須要URL請求的資源須要訪問資源的請求連接

{
 "status": 0, "msg": "ok", "results":[ { "name":"肯德基(羅餐廳)", "img": "https://image.baidu.com/kfc/001.png" } ... ] }

基於原生django書寫知足restful規範的接口

兩個url 對應 一個視圖類 完成十大接口，用到路由分發

路由分發須要在app文件夾下也建立一個urls.py文件

項目名下的urls.py

from django.conf.urls import url, include from django.contrib import admin from api import views urlpatterns = [ url(r'^admin/', admin.site.urls), url(r'^test/', views.Test.as_view()), # 路由分發 url(r'^api/', include('api.urls')), ]

app名下的urls.py：api\urls.py

from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/$', views.Book.as_view()), # 羣查 url(r'^books/(?P<pk>\d+)/$', views.Book.as_view()), # 單查 ]

上面兩個url都對應視圖函數文件內的視圖類Book

view.py

from django.http import JsonResponse from django.views import View from . import models from rest_framework.views import APIView class Book(View): def get(self, request, *args, **kwargs): pk = kwargs.get('pk', None) if pk: # 單查 book_dic = models.Book.objects.filter(pk=pk).values('name', 'price').first() results = book_dic else: # 羣查 book_query = models.Book.objects.values('name', 'price') results = list(book_query) if not results: return JsonResponse({ 'status': 1, 'msg': 'data error', }) return JsonResponse({ 'status': 0, 'msg': 'ok', 'results': results })

CBV請求生命週期

as_view()方法完成路由匹配 => url請求會調用as_view()的返回值視圖函數view => 調用dispatch()方法完成請求分發 => 視圖類的具體視圖方法處理請求 => 返回給前臺