一:基礎簡介
(1)接口:
(1)生活中:連接兩個物體的媒介
(2)web:連接前段后端的媒介
(2)接口的組成
(1)url:
(2)請求參數:按照后端的要求 前段輸入指定的key提交給后端
(3)響應結果:后台與數據庫交互數據 傳遞給前端
二:restfull接口規范
(1)作用:
(1)根據不同的語音環境寫同樣的接口 后端也能獲取數據
(2)接口組成
(1)url
1: 用api關鍵字標識接口url api.baidu.com | www.baidu.com/api 2):接口數據安全性決定優先選擇https協議 3: 如果一個接口有多版本存在,需要在url中標識體現 api.baidu.com/v1/... | api.baidu.com/v2/... 4):接口操作的數據源稱之為 資源,在url中一般采用資源復數形式,一個接口可以概括對該資源的多種操作方式 api.baidu.com/books | api.baidu.com/books/(pk) 5: 請求方式有多種,用一個url處理如何保證不混亂 - 通過請求方式標識操作資源的方式 /books get 獲取所有 /books post 增加一個(多個) /books/(pk) delete 刪除一個 /books/(pk) put 整體更新一個 /books/(pk) patch 局部更新一個 6: 資源往往涉及數據的各種操作方式 - 篩選、排序、限制 api.baidu.com/books/?search=西&ordering=-price&limit=3
(2)響應數據
1: http請求的響應會有響應狀態碼,接口用來返回操作的資源數據,可以擁有 操作數據結果的 狀態碼 status 0(操作資源成功) 1(操作資源失敗) 2(操作資源成功,但沒匹配結果) 注:資源狀態碼不像http狀態碼,一般都是后台與前台或是客戶約定的 2: 資源的狀態碼文字提示 status ok '賬號有誤' '密碼有誤' '用戶鎖定' 3: 資源本身 results 注:刪除資源成功不做任何數據返回(返回空字符串) 4: 不能直接放回的資源(子資源、圖片、視頻等資源),返回該資源的url鏈接
三:基於restful規范的原生接口書寫方式
# 主路由 做路由分發 from django.conf.urls import url, include from django.contrib import admin
urlpatterns = [ url(r'^admin/', admin.site.urls), # 路由分發 url(r'^api/', include('api.urls')) ]
# api子組件路由 from django.conf.urls import url from . import views urlpatterns = [ url(r'^books/', views.Book.as_view()), url(r'^books/(?P<pk>.*)/$', views.Book.as_view()), ]
# 模型層 from django.db import models class Book(models.Model): title = models.CharField(max_length=64) price = models.DecimalField(max_digits=5, decimal_places=2) class Meta: db_table = 'old_boy_book' # 數據庫重命名 verbose_name = '書籍' # 表格命名 verbose_name_plural = verbose_name # 調用表格 def __str__(self): return '《%s》' % self.title
from . import models # from django.views import View from django.http import JsonResponse class Book(View): def get(self, request, *args, **kwargs): # get請求 primary_key = kwargs.get('primary_key') # 匹配前面有名分組 if not primary_key: # 查詢所有 book_obj_list = models.Book.objects.all() print(book_obj_list) # <QuerySet [<Book: <<西游記>>>, <Book: <<紅樓夢>>>]> book_list = [] # 序列化開始 for book_obj in book_obj_list: back_dic = {} back_dic['name'] = book_obj.name back_dic['price'] = book_obj.price book_list.append(back_dic) # 序列化結束 # 返回數據給前段 return JsonResponse({ 'status': 0, 'msg': '查詢成功', 'results': book_list, }, json_dumps_params={'ensure_ascii': False}) else: # 查詢單個 book_dict = models.Book.objects.filter(pk=primary_key).values('name', 'price').first() print(book_dict, type(book_dict)) # <QuerySet [<Book: <<西游記>>>, <Book: <<紅樓夢>>>]> if not book_dict: # 判斷數據是否存在 return JsonResponse( {'status': 1, 'msg': '該書籍不存在', }, json_dumps_params={'ensure_ascii': False} ) return JsonResponse({ 'status': 1, 'msg': '查詢成功', 'result': book_dict }, json_dumps_params={'ensure_ascii': False} ) def post(self, request, *args, **kwargs): # post請求 print(request.POST.dict()) # {'name': '神墓', 'price': '199.99'} recv_dict = request.POST.dict() book_obj = models.Book.objects.create(**recv_dict) # 獲取用戶輸入的值 將對象打散轉換成字典形式 if not book_obj: return JsonResponse({ 'status': 1, 'msg': '創建異常' }, json_dumps_params={'ensure_ascii': False}) return JsonResponse({ 'status': 0, 'msg': '添加成功', 'results': {'name': book_obj.name, 'price': book_obj.price} }, json_dumps_params={'ensure_ascii': False})
PS:
(1)postman可以完成不同方式的請求:get | post | put ...
(2) postman發送數據包有三種方式:form-data | urlencoding | json
(3)原生django對urlencoding方式數據兼容最好
四:DRF框架
# 安裝 pip3 install djangorestframework
""" 1) 請求走的是APIView的as_view函數 2) 在APIView的as_view調用父類(django原生)的as_view,還禁用了 csrf 認證 3) 在父類的as_view中dispatch方法請求走的又是APIView的dispatch 4) 完成任務方法交給視圖類的請求函數處理,得到請求的響應結果,返回給前台 """
(1)請求模塊 request對象
(1)源碼入口
APIView類的dispatch方法中:request = self.initialize_request(request, *args, **kwargs)
(2)源碼分析
""" # 二次封裝得到def的request對象 request = self.initialize_request(request, *args, **kwargs) 點進去 # 在rest_framework.request.Request實例化方法中 self._request = request 將原生request作為新request的_request屬性 # 在rest_framework.request.Request的__getattr__方法中 try: return getattr(self._request, attr) # 訪問屬性完全兼容原生request except AttributeError: return self.__getattribute__(attr
class Test(APIView): def get(self, request, *args, **kwargs): # url拼接的參數 print(request._request.GET) # 二次封裝方式 print(request.GET) # 兼容 print(request.query_params) # 拓展 return Response('drf get ok') def post(self, request, *args, **kwargs): # 所有請求方式攜帶的數據包 print(request._request.POST) # 二次封裝方式 print(request.POST) # 兼容 print(request.data) # 拓展,兼容性最強,三種數據方式都可以 print(request.query_params) return Response('drf post ok')
PS:
(1) drf 對原生request做了二次封裝,request._request就是原生request
(2) 原生request對象的屬性和方法都可以被drf的request對象直接訪問(兼容)
(3) drf請求的所有url拼接參數均被解析到query_params中,所有數據包數據都被解析到data中
(2)渲染模塊
(1)源碼入口
APIView類的dispatch方法中:self.response = self.finalize_response(request, response, *args, **kwargs)
(2)源碼分析
""" # 最后解析reponse對象數據 self.response = self.finalize_response(request, response, *args, **kwargs) 點進去 # 拿到運行的解析類的對象們 neg = self.perform_content_negotiation(request, force=True) 點進去 # 獲得解析類對象 renderers = self.get_renderers() 點進去 # 從視圖類中得到renderer_classes請求類,如何實例化一個個對象形參解析類對象列表 return [renderer() for renderer in self.renderer_classes] # 重點:self.renderer_classes獲取renderer_classes的順序 # 自己視圖類的類屬性(局部配置) => # APIView類的類屬性設置 => # 自己配置文件的DEFAULT_RENDERER_CLASSES(全局配置) => # drf配置文件的DEFAULT_RENDERER_CLASSES """
(3)全局配置:所有配置在settings文件配置
REST_FRAMEWORK = { # drf提供的渲染類 'DEFAULT_RENDERER_CLASSES': [ 'rest_framework.renderers.JSONRenderer', 'rest_framework.renderers.BrowsableAPIRenderer', # 此處有bug 源碼問題 注意更改 ], }
(4)局部配置:
class Test(APIView): def get(self, request, *args, **kwargs): return Response('drf get ok') def post(self, request, *args, **kwargs): return Response('drf post ok') # 在setting.py中配置REST_FRAMEWORK,完成的是全局配置,所有接口統一處理 # 如果只有部分接口特殊化,可以完成 - 局部配置 from rest_framework.renderers import JSONRenderer class Test2(APIView): # 局部配置 renderer_classes = [JSONRenderer] def get(self, request, *args, **kwargs): return Response('drf get ok 2') def post(self, request, *args, **kwargs): return Response('drf post ok 2')
