DRF (Django REST framework) 框架介绍(3)
DRF中的Request 與 Response
1. Request
REST framework 傳入視圖的request對象不再是Django默認的HttpRequest對象，而是REST framework提供的擴展了HttpRequest類的Request類的對象。
REST framework 提供了Parser解析器，在接收到請求后會自動根據Content-Type指明的請求數據類型（如JSON、表單等）將請求數據進行parse解析，解析為類字典對象保存到Request對象中。
Request對象的數據是自動根據前端發送數據的格式進行解析之后的結果。
無論前端發送的哪種格式的數據，我們都可以以統一的方式讀取數據。
常用屬性
1）.data
request.data?返回解析之后的請求體數據。類似于Django中標準的request.POST和?request.FILES屬性，但提供如下特性：
- 包含了解析之后的文件和非文件數據
- 包含了對POST、PUT、PATCH請求方式解析后的數據
- 利用了REST framework的parsers解析器，不僅支持表單類型數據，也支持JSON數據
2）.query_params
request.query_params與Django標準的request.GET相同，只是更換了更正確的名稱而已。
2. Response
rest_framework.response.Response
REST framework提供了一個響應類Response，使用該類構造響應對象時，響應的具體數據內容會被轉換（render渲染）成符合前端需求的類型。
REST framework提供了Renderer?渲染器，用來根據請求頭中的Accept（接收數據類型聲明）來自動轉換響應數據到對應格式。如果前端請求中未進行Accept聲明，則會采用默認方式處理響應數據，我們可以通過配置來修改默認響應格式。
REST_FRAMEWORK = {'DEFAULT_RENDERER_CLASSES': ( # 默認響應渲染類'rest_framework.renderers.JSONRenderer', # json渲染器'rest_framework.renderers.BrowsableAPIRenderer', # 瀏覽API渲染器 ) }構造方式
Response(data, status=None, template_name=None, headers=None, content_type=None)data數據不要是render處理之后的數據，只需傳遞python的內建類型數據即可，REST framework會使用renderer渲染器處理data。
data不能是復雜結構的數據，如Django的模型類對象，對于這樣的數據我們可以使用Serializer序列化器序列化處理后（轉為了Python字典類型）再傳遞給data參數。
參數說明：
- data: 為響應準備的序列化處理后的數據；
- status: 狀態碼，默認200；
- template_name: 模板名稱，如果使用HTMLRenderer?時需指明；
- headers: 用于存放響應頭信息的字典；
- content_type: 響應數據的Content-Type，通常此參數無需傳遞，REST framework會根據前端所需類型數據來設置該參數。
常用屬性：
1）.data
傳給response對象的序列化后，但尚未render處理的數據
2）.status_code
狀態碼的數字
3）.content
經過render處理后的響應數據
3. 狀態碼
為了方便設置狀態碼，REST framewrok在rest_framework.status模塊中提供了常用狀態碼常量。
1）信息告知 - 1xx
HTTP_100_CONTINUE HTTP_101_SWITCHING_PROTOCOLS2）成功 - 2xx
HTTP_200_OK HTTP_201_CREATED HTTP_202_ACCEPTED HTTP_203_NON_AUTHORITATIVE_INFORMATION HTTP_204_NO_CONTENT HTTP_205_RESET_CONTENT HTTP_206_PARTIAL_CONTENT HTTP_207_MULTI_STATUS3）重定向 - 3xx
HTTP_300_MULTIPLE_CHOICES HTTP_301_MOVED_PERMANENTLY HTTP_302_FOUND HTTP_303_SEE_OTHER HTTP_304_NOT_MODIFIED HTTP_305_USE_PROXY HTTP_306_RESERVED HTTP_307_TEMPORARY_REDIRECT4）客戶端錯誤 - 4xx
HTTP_400_BAD_REQUEST HTTP_401_UNAUTHORIZED HTTP_402_PAYMENT_REQUIRED HTTP_403_FORBIDDEN HTTP_404_NOT_FOUND HTTP_405_METHOD_NOT_ALLOWED HTTP_406_NOT_ACCEPTABLE HTTP_407_PROXY_AUTHENTICATION_REQUIRED HTTP_408_REQUEST_TIMEOUT HTTP_409_CONFLICT HTTP_410_GONE HTTP_411_LENGTH_REQUIRED HTTP_412_PRECONDITION_FAILED HTTP_413_REQUEST_ENTITY_TOO_LARGE HTTP_414_REQUEST_URI_TOO_LONG HTTP_415_UNSUPPORTED_MEDIA_TYPE HTTP_416_REQUESTED_RANGE_NOT_SATISFIABLE HTTP_417_EXPECTATION_FAILED HTTP_422_UNPROCESSABLE_ENTITY HTTP_423_LOCKED HTTP_424_FAILED_DEPENDENCY HTTP_428_PRECONDITION_REQUIRED HTTP_429_TOO_MANY_REQUESTS HTTP_431_REQUEST_HEADER_FIELDS_TOO_LARGE HTTP_451_UNAVAILABLE_FOR_LEGAL_REASONS5）服務器錯誤 - 5xx
HTTP_500_INTERNAL_SERVER_ERROR HTTP_501_NOT_IMPLEMENTED HTTP_502_BAD_GATEWAY HTTP_503_SERVICE_UNAVAILABLE HTTP_504_GATEWAY_TIMEOUT HTTP_505_HTTP_VERSION_NOT_SUPPORTED HTTP_507_INSUFFICIENT_STORAGE HTTP_511_NETWORK_AUTHENTICATION_REQUIRED視圖說明
1. 兩個基類
1）APIView
rest_framework.views.APIView
APIView是REST framework提供的所有視圖的基類，繼承自Django的View父類。
APIView與View的不同之處在于：
- 傳入到視圖方法中的是REST framework的Request對象，而不是Django的HttpRequeset對象；
- 視圖方法可以返回REST framework的Response對象，視圖會為響應數據設置（render）符合前端要求的格式；
- 任何APIException異常都會被捕獲到，并且處理成合適的響應信息；
- 在進行dispatch()分發前，會對請求進行身份認證、權限檢查、流量控制。
支持定義的屬性：
- authentication_classes?列表或元祖，身份認證類
- permissoin_classes?列表或元祖，權限檢查類
- throttle_classes?列表或元祖，流量控制類
在APIView中仍以常規的類視圖定義方法來實現get() 、post() 或者其他請求方式的方法。
舉例：
from rest_framework.views import APIView from rest_framework.response import Response# url(r'^books/$', views.BookListView.as_view()), class BookListView(APIView): def get(self, request): books = BookInfo.objects.all() serializer = BookInfoSerializer(books, many=True) return Response(serializer.data)2）GenericAPIView
rest_framework.generics.GenericAPIView
繼承自APIVIew，增加了對于列表視圖和詳情視圖可能用到的通用支持方法。通常使用時，可搭配一個或多個Mixin擴展類。
支持定義的屬性：
- 列表視圖與詳情視圖通用：
- queryset?列表視圖的查詢集
- serializer_class?視圖使用的序列化器
- 列表視圖使用：
- pagination_class?分頁控制類
- filter_backends?過濾控制后端
- 詳情頁視圖使用：
- lookup_field?查詢單一數據庫對象時使用的條件字段，默認為'pk'
- lookup_url_kwarg?查詢單一數據時URL中的參數關鍵字名稱，默認與look_field相同
提供的方法：
-
列表視圖與詳情視圖通用：
-
get_queryset(self)
返回視圖使用的查詢集，是列表視圖與詳情視圖獲取數據的基礎，默認返回queryset屬性，可以重寫，例如：
def get_queryset(self):user = self.request.userreturn user.accounts.all() -
get_serializer_class(self)
返回序列化器類，默認返回serializer_class，可以重寫，例如：
def get_serializer_class(self):if self.request.user.is_staff: return FullAccountSerializer return BasicAccountSerializer -
get_serializer(self,?args, *kwargs)
返回序列化器對象，被其他視圖或擴展類使用，如果我們在視圖中想要獲取序列化器對象，可以直接調用此方法。
注意，在提供序列化器對象的時候，REST framework會向對象的context屬性補充三個數據：request、format、view，這三個數據對象可以在定義序列化器時使用。
-
-
詳情視圖使用：
-
get_object(self)?返回詳情視圖所需的模型類數據對象，默認使用lookup_field參數來過濾queryset。 在試圖中可以調用該方法獲取詳情信息的模型類對象。
若詳情訪問的模型類對象不存在，會返回404。
該方法會默認使用APIView提供的check_object_permissions方法檢查當前對象是否有權限被訪問。
-
舉例：
# url(r'^books/(?P<pk>\d+)/$', views.BookDetailView.as_view()), class BookDetailView(GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request, pk): book = self.get_object() serializer = self.get_serializer(book) return Response(serializer.data)2. 五個擴展類
1）ListModelMixin
列表視圖擴展類，提供list(request, *args, **kwargs)方法快速實現列表視圖，返回200狀態碼。
該Mixin的list方法會對數據進行過濾和分頁。
源代碼：
class ListModelMixin(object):""" List a queryset. """ def list(self, request, *args, **kwargs): # 過濾 queryset = self.filter_queryset(self.get_queryset()) # 分頁 page = self.paginate_queryset(queryset) if page is not None: serializer = self.get_serializer(page, many=True) return self.get_paginated_response(serializer.data) # 序列化 serializer = self.get_serializer(queryset, many=True) return Response(serializer.data)舉例：
from rest_framework.mixins import ListModelMixinclass BookListView(ListModelMixin, GenericAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer def get(self, request): return self.list(request)2）CreateModelMixin
創建視圖擴展類，提供create(request, *args, **kwargs)方法快速實現創建資源的視圖，成功返回201狀態碼。
如果序列化器對前端發送的數據驗證失敗，返回400錯誤。
源代碼：
class CreateModelMixin(object):""" Create a model instance. """ def create(self, request, *args, **kwargs): # 獲取序列化器 serializer = self.get_serializer(data=request.data) # 驗證 serializer.is_valid(raise_exception=True) # 保存 self.perform_create(serializer) headers = self.get_success_headers(serializer.data) return Response(serializer.data, status=status.HTTP_201_CREATED, headers=headers) def perform_create(self, serializer): serializer.save() def get_success_headers(self, data): try: return {'Location': str(data[api_settings.URL_FIELD_NAME])} except (TypeError, KeyError): return {}3） RetrieveModelMixin
詳情視圖擴展類，提供retrieve(request, *args, **kwargs)方法，可以快速實現返回一個存在的數據對象。
如果存在，返回200， 否則返回404。
源代碼：
class RetrieveModelMixin(object):""" Retrieve a model instance. """ def retrieve(self, request, *args, **kwargs): # 獲取對象，會檢查對象的權限 instance = self.get_object() # 序列化 serializer = self.get_serializer(instance) return Response(serializer.data)舉例：
class BookDetailView(RetrieveModelMixin, GenericAPIView):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializerdef get(self, request, pk): return self.retrieve(request)4）UpdateModelMixin
更新視圖擴展類，提供update(request, *args, **kwargs)方法，可以快速實現更新一個存在的數據對象。
同時也提供partial_update(request, *args, **kwargs)方法，可以實現局部更新。
成功返回200，序列化器校驗數據失敗時，返回400錯誤。
源代碼：
class UpdateModelMixin(object):""" Update a model instance. """ def update(self, request, *args, **kwargs): partial = kwargs.pop('partial', False) instance = self.get_object() serializer = self.get_serializer(instance, data=request.data, partial=partial) serializer.is_valid(raise_exception=True) self.perform_update(serializer) if getattr(instance, '_prefetched_objects_cache', None): # If 'prefetch_related' has been applied to a queryset, we need to # forcibly invalidate the prefetch cache on the instance. instance._prefetched_objects_cache = {} return Response(serializer.data) def perform_update(self, serializer): serializer.save() def partial_update(self, request, *args, **kwargs): kwargs['partial'] = True return self.update(request, *args, **kwargs)5）DestroyModelMixin
刪除視圖擴展類，提供destroy(request, *args, **kwargs)方法，可以快速實現刪除一個存在的數據對象。
成功返回204，不存在返回404。
源代碼：
class DestroyModelMixin(object):""" Destroy a model instance. """ def destroy(self, request, *args, **kwargs): instance = self.get_object() self.perform_destroy(instance) return Response(status=status.HTTP_204_NO_CONTENT) def perform_destroy(self, instance): instance.delete()3. 幾個可用子類視圖
1） CreateAPIView
提供 post 方法
繼承自： GenericAPIView、CreateModelMixin
2）ListAPIView
提供 get 方法
繼承自：GenericAPIView、ListModelMixin
3）RetireveAPIView
提供 get 方法
繼承自: GenericAPIView、RetrieveModelMixin
4）DestoryAPIView
提供 delete 方法
繼承自：GenericAPIView、DestoryModelMixin
5）UpdateAPIView
提供 put 和 patch 方法
繼承自：GenericAPIView、UpdateModelMixin
6）RetrieveUpdateAPIView
提供 get、put、patch方法
繼承自： GenericAPIView、RetrieveModelMixin、UpdateModelMixin
7）RetrieveUpdateDestoryAPIView
提供 get、put、patch、delete方法
繼承自：GenericAPIView、RetrieveModelMixin、UpdateModelMixin、DestoryModelMixin
視圖集ViewSet
使用視圖集ViewSet，可以將一系列邏輯相關的動作放到一個類中：
- list() 提供一組數據
- retrieve() 提供單個數據
- create() 創建數據
- update() 保存數據
- destory() 刪除數據
ViewSet視圖集類不再實現get()、post()等方法，而是實現動作?action?如 list() 、create() 等。
視圖集只在使用as_view()方法的時候，才會將action動作與具體請求方式對應上。如：
class BookInfoViewSet(viewsets.ViewSet):def list(self, request): ... def retrieve(self, request, pk=None): ...在設置路由時，我們可以如下操作
urlpatterns = [url(r'^books/$', BookInfoViewSet.as_view({'get':'list'}),url(r'^books/(?P<pk>\d+)/$', BookInfoViewSet.as_view({'get': 'retrieve'}) ]action屬性
在視圖集中，我們可以通過action對象屬性來獲取當前請求視圖集時的action動作是哪個。
例如：
def get_serializer_class(self):if self.action == 'create': return OrderCommitSerializer else: return OrderDataSerializer常用視圖集父類
1） ViewSet
繼承自APIView，作用也與APIView基本類似，提供了身份認證、權限校驗、流量管理等。
在ViewSet中，沒有提供任何動作action方法，需要我們自己實現action方法。
2）GenericViewSet
繼承自GenericAPIView，作用也與GenericAPIVIew類似，提供了get_object、get_queryset等方法便于列表視圖與詳情信息視圖的開發。
3）ModelViewSet
繼承自GenericAPIVIew，同時包括了ListModelMixin、RetrieveModelMixin、CreateModelMixin、UpdateModelMixin、DestoryModelMixin。
4）ReadOnlyModelViewSet
繼承自GenericAPIVIew，同時包括了ListModelMixin、RetrieveModelMixin。
視圖集中定義附加action動作
在視圖集中，除了上述默認的方法動作外，還可以添加自定義動作。
添加自定義動作需要使用rest_framework.decorators.action裝飾器。
以action裝飾器裝飾的方法名會作為action動作名，與list、retrieve等同。
action裝飾器可以接收兩個參數：
- methods: 該action支持的請求方式，列表傳遞
- detail: 表示是action中要處理的是否是視圖資源的對象（即是否通過url路徑獲取主鍵）
- True 表示使用通過URL獲取的主鍵對應的數據對象
- False 表示不使用URL獲取主鍵
舉例：
from rest_framework import mixins from rest_framework.viewsets import GenericViewSet from rest_framework.decorators import action class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer # detail為False 表示不需要處理具體的BookInfo對象 @action(methods=['get'], detail=False) def latest(self, request): """ 返回最新的圖書信息 """ book = BookInfo.objects.latest('id') serializer = self.get_serializer(book) return Response(serializer.data) # detail為True，表示要處理具體與pk主鍵對應的BookInfo對象 @action(methods=['put'], detail=True) def read(self, request, pk): """ 修改圖書的閱讀量數據 """ book = self.get_object() book.bread = request.data.get('read') book.save() serializer = self.get_serializer(book) return Response(serializer.data)url的定義
urlpatterns = [url(r'^books/$', views.BookInfoViewSet.as_view({'get': 'list'})),url(r'^books/latest/$', views.BookInfoViewSet.as_view({'get': 'latest'})), url(r'^books/(?P<pk>\d+)/$', views.BookInfoViewSet.as_view({'get': 'retrieve'})), url(r'^books/(?P<pk>\d+)/read/$', views.BookInfoViewSet.as_view({'put': 'read'})), ]路由Routers
對于視圖集ViewSet，我們除了可以自己手動指明請求方式與動作action之間的對應關系外，還可以使用Routers來幫助我們快速實現路由信息。
REST framework提供了兩個router
- SimpleRouter
- DefaultRouter
1. 使用方法
1） 創建router對象，并注冊視圖集，例如
from rest_framework import routersrouter = routers.SimpleRouter() router.register(r'books', BookInfoViewSet, base_name='book')register(prefix, viewset, base_name)
- prefix 該視圖集的路由前綴
- viewset 視圖集
- base_name 路由名稱的前綴
如上述代碼會形成的路由如下：
^books/$ name: book-list ^books/{pk}/$ name: book-detail2）添加路由數據
可以有兩種方式：
urlpatterns = [... ] urlpatterns += router.urls或
urlpatterns = [...url(r'^', include(router.urls)) ]2. 視圖集中包含附加action的
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializer @action(methods=['get'], detail=False) def latest(self, request): ... @action(methods=['put'], detail=True) def read(self, request, pk): ...此視圖集會形成的路由：
^books/latest/$ name: book-latest ^books/{pk}/read/$ name: book-read3. 路由router形成URL的方式
1） SimpleRouter
?
2）DefaultRouter
?
DefaultRouter與SimpleRouter的區別是，DefaultRouter會多附帶一個默認的API根視圖，返回一個包含所有列表視圖的超鏈接響應數據。
?
認證Authentication
可以在配置文件中配置全局默認的認證方案
REST_FRAMEWORK = {'DEFAULT_AUTHENTICATION_CLASSES': ('rest_framework.authentication.BasicAuthentication', # 基本認證'rest_framework.authentication.SessionAuthentication', # session認證 ) }也可以在每個視圖中通過設置authentication_classess屬性來設置
from rest_framework.authentication import SessionAuthentication, BasicAuthentication from rest_framework.views import APIViewclass ExampleView(APIView): authentication_classes = (SessionAuthentication, BasicAuthentication) ...認證失敗會有兩種可能的返回值：
- 401 Unauthorized 未認證
- 403 Permission Denied 權限被禁止
權限Permissions
權限控制可以限制用戶對于視圖的訪問和對于具體數據對象的訪問。
- 在執行視圖的dispatch()方法前，會先進行視圖訪問權限的判斷
- 在通過get_object()獲取具體對象時，會進行對象訪問權限的判斷
使用
可以在配置文件中設置默認的權限管理類，如
REST_FRAMEWORK = {'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.IsAuthenticated',) }如果未指明，則采用如下默認配置
'DEFAULT_PERMISSION_CLASSES': ('rest_framework.permissions.AllowAny', )也可以在具體的視圖中通過permission_classes屬性來設置，如
from rest_framework.permissions import IsAuthenticated from rest_framework.views import APIViewclass ExampleView(APIView): permission_classes = (IsAuthenticated,) ...提供的權限
- AllowAny 允許所有用戶
- IsAuthenticated 僅通過認證的用戶
- IsAdminUser 僅管理員用戶
- IsAuthenticatedOrReadOnly 認證的用戶可以完全操作，否則只能get讀取
舉例
from rest_framework.authentication import SessionAuthentication from rest_framework.permissions import IsAuthenticated from rest_framework.generics import RetrieveAPIView class BookDetailView(RetrieveAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer authentication_classes = [SessionAuthentication] permission_classes = [IsAuthenticated]自定義權限
如需自定義權限，需繼承rest_framework.permissions.BasePermission父類，并實現以下兩個任何一個方法或全部
-
.has_permission(self, request, view)
是否可以訪問視圖， view表示當前視圖對象
-
.has_object_permission(self, request, view, obj)
是否可以訪問數據對象， view表示當前視圖， obj為數據對象
例如：
class MyPermission(BasePermission):def has_object_permission(self, request, view, obj): """控制對obj對象的訪問權限，此案例決絕所有對對象的訪問""" return False class BookInfoViewSet(ModelViewSet): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer permission_classes = [IsAuthenticated, MyPermission]限流Throttling
可以對接口訪問的頻次進行限制，以減輕服務器壓力。
使用
可以在配置文件中，使用DEFAULT_THROTTLE_CLASSES?和?DEFAULT_THROTTLE_RATES進行全局配置，
REST_FRAMEWORK = {'DEFAULT_THROTTLE_CLASSES': ('rest_framework.throttling.AnonRateThrottle','rest_framework.throttling.UserRateThrottle'),'DEFAULT_THROTTLE_RATES': {'anon': '100/day', 'user': '1000/day' } }DEFAULT_THROTTLE_RATES?可以使用?second,?minute,?hour?或day來指明周期。
也可以在具體視圖中通過throttle_classess屬性來配置，如
from rest_framework.throttling import UserRateThrottle from rest_framework.views import APIViewclass ExampleView(APIView): throttle_classes = (UserRateThrottle,) ...可選限流類
1） AnonRateThrottle
限制所有匿名未認證用戶，使用IP區分用戶。
使用DEFAULT_THROTTLE_RATES['anon']?來設置頻次
2）UserRateThrottle
限制認證用戶，使用User id 來區分。
使用DEFAULT_THROTTLE_RATES['user']?來設置頻次
3）ScopedRateThrottle
限制用戶對于每個視圖的訪問頻次，使用ip或user id。
例如：
class ContactListView(APIView):throttle_scope = 'contacts'...class ContactDetailView(APIView):throttle_scope = 'contacts'...class UploadView(APIView):throttle_scope = 'uploads'... REST_FRAMEWORK = {'DEFAULT_THROTTLE_CLASSES': ('rest_framework.throttling.ScopedRateThrottle',),'DEFAULT_THROTTLE_RATES': {'contacts': '1000/day','uploads': '20/day'} }實例
from rest_framework.authentication import SessionAuthentication from rest_framework.permissions import IsAuthenticated from rest_framework.generics import RetrieveAPIView from rest_framework.throttling import UserRateThrottle class BookDetailView(RetrieveAPIView): queryset = BookInfo.objects.all() serializer_class = BookInfoSerializer authentication_classes = [SessionAuthentication] permission_classes = [IsAuthenticated] throttle_classes = (UserRateThrottle,)過濾Filtering
對于列表數據可能需要根據字段進行過濾，我們可以通過添加django-fitlter擴展來增強支持。
pip insall django-filter在配置文件中增加過濾后端的設置：
INSTALLED_APPS = [...'django_filters', # 需要注冊應用， ]REST_FRAMEWORK = {'DEFAULT_FILTER_BACKENDS': ('django_filters.rest_framework.DjangoFilterBackend',) }在視圖中添加filter_fields屬性，指定可以過濾的字段
class BookListView(ListAPIView):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializerfilter_fields = ('btitle', 'bread') # 127.0.0.1:8000/books/?btitle=西游記排序
對于列表數據，REST framework提供了OrderingFilter過濾器來幫助我們快速指明數據按照指定字段進行排序。
使用方法：
在類視圖中設置filter_backends，使用rest_framework.filters.OrderingFilter過濾器，REST framework會在請求的查詢字符串參數中檢查是否包含了ordering參數，如果包含了ordering參數，則按照ordering參數指明的排序字段對數據集進行排序。
前端可以傳遞的ordering參數的可選字段值需要在ordering_fields中指明。
示例：
class BookListView(ListAPIView):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializerfilter_backends = [OrderingFilter]ordering_fields = ('id', 'bread', 'bpub_date') # 127.0.0.1:8000/books/?ordering=-bread分頁Pagination
REST framework提供了分頁的支持。
我們可以在配置文件中設置全局的分頁方式，如：
REST_FRAMEWORK = {'DEFAULT_PAGINATION_CLASS': 'rest_framework.pagination.PageNumberPagination','PAGE_SIZE': 100 # 每頁數目 }也可通過自定義Pagination類，來為視圖添加不同分頁行為。在視圖中通過pagination_clas屬性來指明。
class LargeResultsSetPagination(PageNumberPagination):page_size = 1000 page_size_query_param = 'page_size' max_page_size = 10000 class BookDetailView(RetrieveAPIView):queryset = BookInfo.objects.all()serializer_class = BookInfoSerializerpagination_class = LargeResultsSetPagination注意：如果在視圖內關閉分頁功能，只需在視圖內設置
pagination_class = None可選分頁器
1）?PageNumberPagination
前端訪問網址形式：
GET http://api.example.org/books/?page=4可以在子類中定義的屬性：
- page_size 每頁數目
- page_query_param 前端發送的頁數關鍵字名，默認為"page"
- page_size_query_param 前端發送的每頁數目關鍵字名，默認為None
- max_page_size 前端最多能設置的每頁數量
2）LimitOffsetPagination
前端訪問網址形式：
GET http://api.example.org/books/?limit=100&offset=400可以在子類中定義的屬性：
- default_limit 默認限制，默認值與PAGE_SIZE設置一直
- limit_query_param limit參數名，默認'limit'
- offset_query_param offset參數名，默認'offset'
- max_limit 最大limit限制，默認None
版本Versioning
REST framework提供了版本號的支持。
在需要獲取請求的版本號時，可以通過request.version來獲取。
默認版本功能未開啟，request.version?返回None。
開啟版本支持功能，需要在配置文件中設置DEFAULT_VERSIONING_CLASS
REST_FRAMEWORK = {'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.NamespaceVersioning' }其他可選配置：
- DEFAULT_VERSION?默認版本號，默認值為None
- ALLOWED_VERSIONS?允許請求的版本號，默認值為None
- VERSION_PARAM?識別版本號參數的名稱，默認值為'version'
支持的版本處理方式
1） AcceptHeaderVersioning
請求頭中傳遞的Accept攜帶version
GET /bookings/ HTTP/1.1 Host: example.com Accept: application/json; version=1.02）URLPathVersioning
URL路徑中攜帶
urlpatterns = [url(r'^(?P<version>(v1|v2))/bookings/$',bookings_list,name='bookings-list'),url(r'^(?P<version>(v1|v2))/bookings/(?P<pk>[0-9]+)/$',bookings_detail,name='bookings-detail') ]3）NamespaceVersioning
命名空間中定義
# bookings/urls.py urlpatterns = [url(r'^$', bookings_list, name='bookings-list'),url(r'^(?P<pk>[0-9]+)/$', bookings_detail, name='bookings-detail') ] # urls.py urlpatterns = [ url(r'^v1/bookings/', include('bookings.urls', namespace='v1')), url(r'^v2/bookings/', include('bookings.urls', namespace='v2')) ]4）HostNameVersioning
主機域名攜帶
GET /bookings/ HTTP/1.1 Host: v1.example.com Accept: application/json5）QueryParameterVersioning
查詢字符串攜帶
GET /something/?version=0.1 HTTP/1.1 Host: example.com Accept: application/json示例
REST_FRAMEWORK = {'DEFAULT_VERSIONING_CLASS': 'rest_framework.versioning.QueryParameterVersioning' } class BookInfoSerializer(serializers.ModelSerializer):"""圖書數據序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date', 'bread', 'bcomment') class BookInfoSerializer2(serializers.ModelSerializer): """圖書數據序列化器""" class Meta: model = BookInfo fields = ('id', 'btitle', 'bpub_date') class BookDetailView(RetrieveAPIView): queryset = BookInfo.objects.all() def get_serializer_class(self): if self.request.version == '1.0': return BookInfoSerializer else: return BookInfoSerializer2 # 127.0.0.1:8000/books/2/ # 127.0.0.1:8000/books/2/?version=1.0異常處理 Exceptions
REST framework提供了異常處理，我們可以自定義異常處理函數。
from rest_framework.views import exception_handlerdef custom_exception_handler(exc, context): # 先調用REST framework默認的異常處理方法獲得標準錯誤響應對象 response = exception_handler(exc, context) # 在此處補充自定義的異常處理 if response is not None: response.data['status_code'] = response.status_code return response在配置文件中聲明自定義的異常處理
REST_FRAMEWORK = {'EXCEPTION_HANDLER': 'my_project.my_app.utils.custom_exception_handler' }如果未聲明，會采用默認的方式，如下
REST_FRAMEWORK = {'EXCEPTION_HANDLER': 'rest_framework.views.exception_handler' }例如：
補充上處理關于數據庫的異常
from rest_framework.views import exception_handler as drf_exception_handler from rest_framework import status from django.db import DatabaseError def exception_handler(exc, context): response = drf_exception_handler(exc, context) if response is None: view = context['view'] if isinstance(exc, DatabaseError): print('[%s]: %s' % (view, exc)) response = Response({'detail': '服務器內部錯誤'}, status=status.HTTP_507_INSUFFICIENT_STORAGE) return responseREST framework定義的異常
- APIException 所有異常的父類
- ParseError 解析錯誤
- AuthenticationFailed 認證失敗
- NotAuthenticated 尚未認證
- PermissionDenied 權限決絕
- NotFound 未找到
- MethodNotAllowed 請求方式不支持
- NotAcceptable 要獲取的數據格式不支持
- Throttled 超過限流次數
- ValidationError 校驗失敗
自動生成接口文檔
REST framework可以自動幫助我們生成接口文檔。
接口文檔以網頁的方式呈現。
自動接口文檔能生成的是繼承自APIView及其子類的視圖。
1. 安裝依賴
REST framewrok生成接口文檔需要coreapi庫的支持。
pip install coreapi2. 設置接口文檔訪問路徑
在總路由中添加接口文檔路徑。
文檔路由對應的視圖配置為rest_framework.documentation.include_docs_urls，
參數title為接口文檔網站的標題。
from rest_framework.documentation import include_docs_urlsurlpatterns = [...url(r'^docs/', include_docs_urls(title='My API title')) ]3. 文檔描述說明的定義位置
1） 單一方法的視圖，可直接使用類視圖的文檔字符串，如
class BookListView(generics.ListAPIView):""" 返回所有圖書信息. """2）包含多個方法的視圖，在類視圖的文檔字符串中，分開方法定義，如
class BookListCreateView(generics.ListCreateAPIView):""" get: 返回所有圖書信息. post: 新建圖書. """3）對于視圖集ViewSet，仍在類視圖的文檔字符串中封開定義，但是應使用action名稱區分，如
class BookInfoViewSet(mixins.ListModelMixin, mixins.RetrieveModelMixin, GenericViewSet):""" list: 返回圖書列表數據 retrieve: 返回圖書詳情數據 latest: 返回最新的圖書數據 read: 修改圖書的閱讀量 """4. 訪問接口文檔網頁
瀏覽器訪問 127.0.0.1:8000/docs/，即可看到自動生成的接口文檔。
兩點說明：
1） 視圖集ViewSet中的retrieve名稱，在接口文檔網站中叫做read
2）參數的Description需要在模型類或序列化器類的字段中以help_text選項定義，如：
class BookInfo(models.Model):...bread = models.IntegerField(default=0, verbose_name='閱讀量', help_text='閱讀量') ...或
class BookReadSerializer(serializers.ModelSerializer):class Meta: model = BookInfo fields = ('bread', ) extra_kwargs = { 'bread': { 'required': True, 'help_text': '閱讀量' } } ?轉載于:https://www.cnblogs.com/yinjiangchong/p/9304369.html
總結
以上是生活随笔為你收集整理的DRF (Django REST framework) 框架介绍(3)的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： C++继承中关于子类构造函数的写法
- 下一篇： android入门学习-天气预报app（