Django Rest Framework 教程及API向導。
一、請求（Request）
REST_FRAMEWORK 中的 Request 擴展了標准的HttpRequest,為 REST_FRAMEWORK增加了靈活的request解析和request認證。
1、請求
.data: 獲取請求的主體，相當於request.POST和request.FILES
.query_params: request.GET的重命名
.parsers: APIView類或@api_view裝飾將確保這個屬性將自動設置為一個解析器實例列表
2、內容協商
.accepted_render: 接受渲染一個對象內容協商
.accepted_media_type: 接受的媒體類型
3、身份驗證
.user: 通常返回django.contrib.auth.models.user的對象。雖然行為取決於所使用的身份驗證策略。
如果請求用戶沒有被認證，request.user是一個django.contrib.auth.models.Anoymoser對象。
.auth: 被認證的后才會被使用，返回任何額外身份的環境。
.authenticators: APIView類或@api_view裝飾將確保這個屬性將自動設置為一個認證實例列表
4、瀏覽器增強方法
django rest framework提供一些附加的表單提交方法:PUT,PATCH,DELETE
.method: 返回一個大寫的HTTP請求方法字符串，包含了PUT,PATCH,DELETE等。
.content_type: 返回一個字符串對象代表HTTP請求的媒體類型的身體,或如果沒有媒體類型提供一個空字符串。
同樣可以使用：request.META.get(‘HTTP_CONTENT_TYPE’)
.stream: 返回一個請求主體類容的流。
5、 支持其他標准的HttpResquest屬性
.META/.session/等等
二、Response（響應）
你需要使用一個APIView類或@api_view函數返回response對象的views
1、創建Response
from rest_framework.response import Response
例: Response(data, status=None, template_name=None, headers=None, content_type=None)
data: 響應serialized(序列化)后的數據
status: 定義響應狀態碼，默認200
template_name: 如果HTMLRender被選擇，返回一個模板
headers: 是關於HTTP請求頭的一個字典
content_type: 響應內容類型，一般會根據內容自動協商。
2、其他標准的HttpResponse屬性
response = Response()
response[‘Cache-Control’] = ‘no-cache’
.render(): 響應序列化的數據。
三、基本視圖類 (APIView/@api_view)
1、類基礎視圖（APIView）
DRF不同於django常規的view類，他有如下幾點優點：
* 提供了更好用的request對象，不同於普通的django HttpRequest更好用。
* 封裝了Response對象，代替了原有的django HttpResponse，視圖將管理內容協商並設置正確的渲染器的響應。
* 任何APIException異常將會被捕捉，並做適當的響應。
* 傳入的請求將身份驗證和適當的權限和節流檢查將之前運行調度請求處理程序的方法。
一個小例子：
from rest_framework.views import APIView from rest_framework.response import Response from rest_framework import authenication, permissions class ListUser(APIView): “””
展示系統中所有的用戶
* 需要令牌認證。
* 只有admin用戶能夠訪問這一個視圖
""" authentication_classes = (authentication.TokenAuthentication,) # 認證策略屬性 permission_classes = (permissions.IsAdminUser,) # 權限策略屬性 def get(self, requeset, format=None): """ 返回一個用戶列表 """ usernames = [user.username for user in User.objects.all()] return Response(usernames)
1） API策略屬性
以下的API策略屬性應用於APIView，控制視圖的策略：
renderer_classes： 渲染器類
parser_classes： 解釋器類
authentication_classes： 權限類
throttle_classes：節流類
permission_classes： 權限類
content_negotiation_class： 內容協商類
2）API 策略方法
以下的策略方法用在API的策略，通常不用重寫它：
get_renderers(self): 獲取渲染器方法
get_parsers(self): 獲取解釋器方法
get_authenticators(self): 或缺認證方法
get_throttles(self): 獲取節流方法
get_permissions(self): 獲取權限方法
get_content_negotiator(self): 獲取內容協商方法
3）API策略實施方法
下列方法之前被稱為調度處理程序方法：
check_permissions(self, request): 檢查權限
check_throttles(self, request): 檢查節流
check_content_negotiation(self, request, force=False): 檢查內容協商
4）調度方法
這些執行任何操作,需要發生之前或之后調用處理程序方法等.
initial(self, request, *args, **kwargs): 執行任何操作,需要發生在處理程序方法之前被調用。這個方法是用來執行權限和節流,並執行內容協商。
handle_exception(self, exc)：拋出的任何異常處理程序方法將被傳遞給這個方法,而返回響應實例,或者re-raises異常。
initialize_request(self, request, *args, **kwargs)：確保請求對象傳遞給處理程序方法是request的一個實例，而不是django的HttpRequest
finalize_response(self, request, response, *args, **kwargs)：確保任何響應處理程序方法返回的對象將被呈現到正確的內容類型
2、函數基礎視圖（@api_view()）
DRF同樣提供了另外一種函數基礎視圖來裝飾django的普通視圖，我們同樣可以使用request來接受請求和response響應。
一個小例子：
from rest_framework.decorators import api_view @api_view def hello_world(request): return Response({“message”:”Hello world!”})
1）api_view()使用方法
這個視圖將使用默認渲染器、解析器、身份驗證設置中指定的類等。通常默認只有GET方法，其他請求方法會報405錯誤，我們可以手動添加方法為這
裝飾器指定request方法。像這樣：
@api_view([‘GET’, ‘POST’]) def hello_world(request): if request.method == ‘POST’: return Response({“message”:”Got some data”, “data”: request.data}) return Response({“messsage”:”Hello world!”})
2）API策略裝飾器
DRF提供了很多附加的裝飾器，我們可以添加到@api_view()后面，例如要加入一個節流的裝飾器來確保特定用戶每天只能一次通過這個視圖，我
我們就要用到@throttle_classes裝飾器：
from rest_framework.decorators import api_view, throttle_classes from rest_framework.throttling import UserRateThrottle class OncePerDayUserThrottle(UserRateThrottle): rate = “1/day” @api_view([‘GET’]) @throttle_classes([OncePerDayUserThrottle]) def view(request): return Response({“message”:”Hello for to day! see you tomorrow!”})
其他可用API的裝飾器：
@renderer_classes(…)
@parser_classes(…)
@authentication_classes(…)
@throttle_classes(…)
@permission_classes(…)
四、 通用視圖（Generic views）
基於類視圖的主要好處之一是他們允許您編寫可重用的行為.
REST框架提供的通用視圖允許您快速構建API觀點緊密地映射到您的數據庫模型.
如果通用視圖不適合你的需要API,您可以使用常規APIView類,或重用mixin和基類使用的通用視圖來組成自己的組可重用通用視圖。
1、通用視圖
同樣我們可以設置一些類屬性在通用視圖內，也可以根據特殊要寫重寫它的內部視圖方法。一個小例子：
from django.contrib.auth.models import User from myapp.serializers import UserSerializer from rest_framework import generics from rest_framework.permissions import IsAdminUser class UserList(generics.ListCreateAPIView): queryset = User.objects.all() serializer_class = UserSerializer permission_classes = (IsAdminUser,) def list(self, request): # Note the use of get_queryset() instead of self.queryset queryset = self.get_queryset() serializer = UserSerializer(queryset, many=True) return Response(serializer.data)
在urls配置中，我們可以使用.as_views()來轉換成視圖函數，當然也可以配置一些屬性
url(r’^/users/’, ListCreateAPIView.as_view(queryset=User.objects.all(), serializer_class=UserSerializer), name=’user-list’)
2、GenericAPIView通用視圖API參考：
GenericAPIView繼承了DRF的APIView類，為list和detail視圖增加了一些一般需求行為方法（提供queryset）。
1）屬性
基本屬性：
queryset: 用於返回query對象集合，也可以使用get_queryset()方法。
serializer_class: 序列化器類,應該用於輸入進行驗證和反序列化,並用於序列化輸出。通常情況下,你必須設置這個屬性,或重寫get_serializer_class()方法。
lookup_field: 模型的字段應該用於執行對象查找個別的模型實例
ookup_url_kwarg:URL應該用於對象查找關鍵字參數
分頁屬性：
pagination_class: 用於返回一個分頁列表視圖的分頁類，默認與settings中設置的DEFAULT_PAGINATION_CLASS 值相同，
可以通過’rest_framework.pagination.PageNumberPagination’設置分頁數
過濾器屬性：
filter_backends: 過濾queryset的類列表，和在settings中設置DEFAULT_FILTER_BACKENDS 一樣
2）方法
基本方法：
get_queryset(): 返回queryset。（詳情見官網http://www.django-rest-framework.org/api-guide/generic-views/）
get_object():獲取某一個具體的model實例對象。
保存與刪除掛鈎方法：
以下方法是mixins類提供，提供簡單的對象保存和刪除的行為重寫：
perform_create(self, serializer): CreateModelMixin 當要保存對象時候會被調用
perform_update(self, serializer):UpdateModelMixin 當要更新對象時候會被調用
perform_destroy(self, instance): DestoryModelMixin 當葯刪除對象時候會被調用
3、Mixins
mixin類提供用於提供基礎視圖的操作行為。注意,mixin類提供操作方法而不是定義處理程序方法,比如. get()和. post(),直接。這允許更靈活的組合的行為。
通過rest_framework.mixins引用。
ListModelMixin：提供list方法，列出queryset
CreateModelMixin： 提供create方法，創建和保存一個Model對象
RetrieveModelMixin：提供retrieve方法，檢索一個存在的model對象
UpdateModelMixin： 提供Update方法，更改一個模型對象
DestroyModelMixin：提供destroy方法，刪除一個模型對象
4）Generic
Generic通用視圖類提供具體操作的通用視圖類，可以理解為Generic.GenericAPIView和mixin類的合體，通過rest_framework.generic.調用
.CreateAPIView:
創建一個模型實例
提供post方法的處理器
繼承於：GenericAPIView，CreateModelMixin
.ListAPIView:
模型實例的集合
提供get方法處理器
繼承於：GenericAPIView，ListModelMixin
.RetrieveAPIView:
一個模型實例
提供get方法處理器
繼承於：GenericAPIView，RetrieveModelMixin
.DestoryAPIView:
刪除一個模型實例
提供delete方法處理器
繼承於：GenericAPIView，DestroyModelMixin
.UpdateAPIView:
修改模型實例，
提供put和patch方法處理器
繼承於：GenericAPIView，UpdateModelMixin
.ListCreateAPIView:
創建和展示一個模型實例集合
提供get和post處理器
繼承於：GenericAPIView，ListModelMixin，CreateModelMixin
.RetrieveUpdateAPIView:
讀和改一個模型實例
提供get,put,patch處理器
繼承於：GenericAPIView，RetrieveModelMixin，UpdateModelMixin
.RetrieveDestoryAPIView:
讀和刪除一個模型實例
提供get和delete處理器
繼承於：GenericAPIView，RetrieveModelMixin，DestroyModelMixin
.RetrieveUpdateDestroyAPIView：
讀、改和刪一個模型實例
get, put, patch,delete處理器
繼承於：GenericAPIView，RetrieveModelMixin，UpdateModelMixin，DestroyModelMixin
五、視圖集合ViewSets
Django REST框架允許您將一組相關的邏輯視圖在一個類，ViewSet類是一個簡單類型的基於類的觀點,沒有提供任何方法處理程序如.get()或. post(),
而代替提供方法比如.list()和create()。
一個小例子：
from django.contrib.auth.models import User from django.shortcuts import get_object_or_404 from myapps.serializers import UserSerializer from rest_framework import viewsets from rest_framework.response import Response class UserViewSet(viewsets.ViewSet): “”” A simple ViewSet for listing or retrieving users. “”” def list(self, request): queryset = User.objects.all() serializer = UserSerializer(queryset, many=True) return Response(serializer.data) def retrieve(self, request, pk=None): queryset = User.objects.all() user = get_object_or_404(queryset, pk=pk) serializer = UserSerializer(user) return Response(serializer.data)
1）關於ViewSets
如果我們需要，我們需要為兩個GET請求分開綁定視圖：
user_list = UserViewSet.as_view({“GET”:’list’})
user_detail = UserViewSet.as_view({‘GET’:’retrieve’})
但是通常我們不會這樣做，而是通過注冊路由來配置url：
from myapp.views import UserViewSet from rest_framework.routers import DefaultRouter router = DefaultRouter() router.register(r’users’, UserViewSet) urlpatterns = router.urls
或許你會經常用到自己模型數據，而不是手動寫視圖集合，這樣就要用到模型視圖集合ModelViewSet:
class UserViewSet(viewsets.ModelViewSet): “”” A viewset for viewing and editing user instance “”” serializer_class = UserSerializer queryset = User.objects.all()
其他路由函數方法：
class UserViewSet(viewsets.ViewSet): “”” Example empty viewset demonstrating the standard actions that will be handled by a router class. If you’re using format suffixes, make sure to also include the format=None keyword argument for each action. “”” def list(self, request): pass def create(self, request): pass def retrieve(self, request, pk=None): pass def update(self, request, pk=None): pass def partial_update(self, request, pk=None): pass def destroy(self, request, pk=None): pass 如果你有特別的需要被路由到的方法,可以將它們標記為需要路由使用@detail_route或@list_route修飾符。 @detail_route(methods=[‘post’], permission_classes=[IsAdminOrIsSelf]) def set_password(self, request, pk=None): … 可以通過訪問^users/{pk}/set_password/$來訪問改視圖
2）ViewSets的API參考
.ViewSet：
繼承了APIView，你可以使用一些標准的屬性例如permission_class,authentication_classes去對視圖做一些策略。ViewSet同樣不提供具體
行為方法的實現，你可以重寫和定義一些請求處理方法。而代替了原來APIVIew的POST，GET等方法，取而代之的是list，create等方法。
.GenericViewSet:
繼承了GenericAPIView，提供了默認的get_queryset()和get_object()等方法來獲取model數據，但不提供任何請求處理方法。
.ModelViewSet:
繼承了GenericAPIView，增加了一些請求處理方法，如list(), retrieve(),create()等。
例子：
class AccountViewSet(viewsets.ModelViewSet): “”” A simple ViewSet for viewing and editing accounts “”” queryset = Account.objects.all() serializer_class = AccountSerializer permissions_classes = [IsAccountAdminOrReadOnly]
.ReadOnlyModelViewSet:
繼承了GenericAPIView，只增加了只讀的請求處理方法list()和retrieve()
自定義View類：
只需要繼承GenericAPIView, 增加mixins的相關處理方法。如：
class CreatListRetrieveViewSet(mixins.CreateModelMixin, mixins.ListModelMixin, mixins.RetrieveModelMixin, View.GenericViewSet): pass
六、路由(routers)
1、REST框架還支持自動Django URL路由,並為您提供了一個簡單的、快速的和一致的方式連接視圖邏輯的URL。
如果設置basename將自動生成基於queryset viewset的屬性,如果它有一個。注意,如果viewset不包括queryset屬性然后注冊時必須設置base_name viewset。
from rest_framework import routers router = routers.SimpleRouter() router.register(r’users’, UserViewSet, ‘users’) router.register(r’accounts’, AccountViewSet) urlpatterns = router.urls 注意：router.register有三個參數屬性： *prefix：這是url匹配正則表達式。 *viewset: 指定視圖集合 *base_name: 基於基礎的url名字設置。這個特別要注意，如果不加這個參數，那么視圖集合必須要包含queryset這個屬性。
2、使用路由routers
router = routers.SimpleRouter() router.register(r’users’, UserViewSet) urlpatterns = [ url(r’^api/’, include(router.urls, namespace=’api’)), ] 或者：urlpatterns +=router.urls
3、@detail_route / @list_route指定路由
@detail_route(methods=[‘post’], permission_classes=[IsAdminOrIsSelf])
->指定post方法，權限為IsAdminOrIsSelf
七、解釋器(parse)
1、設置解釋器
設置成全局：
REST_FRAMEWORK ={
‘DEFAULT_PARSER_CLASSES’: (‘rest_framework.parsers.JSONParser’,）
}
也可以在視圖APIView中設置：
from rest_framework.parsers import JSONParser parser_class = (JSONParser,)
如果是@api_view裝飾的視圖：
@api_view([‘POST’])
@parser_classes((JSONParser,))
2、API 參考
JSONParse: application/json
FormParse: application/x-www-form-urlencoded
MultiPartParser: multipart/form-data
FileUploadParser: */*
–>file_obj = request.data[‘file’]
八、渲染器(renders)
1、設置渲染器
設置成全局：
REST_FRAMEWORK ={
‘rest_framework.renderers.JSONRenderer’,
‘rest_framework.renderers.BrowsableAPIRenderer’,
}
也可以在視圖APIView中設置：
from rest_framework.renderers import JSONRenderer renderer_classes = (JSONRenderer, ) 如果是@api_view裝飾的視圖： @api_view([‘GET’]) @renderer_classes((JSONRenderer,))
九、序列化器serializers
序列化器可以將python的復雜數據格式渲染成json，xml等格式，同時也提供了反序列化器，可以將渲染成的數據解釋成python的數據模型對象。它和django中
的from表單用法很相似。
1、渲染序列化對象：
可以將對象序列化成json,xml格式等
serializer = CommentSerializer(comment) serializer.data # {’email’: ‘leila@example.com’, ‘content’: ‘foo bar’, ‘created’: ‘2016-01-27T15:17:10.375877′} json = JSONRenderer().render(serializer.data) # 渲染成json格式 # b'{“email”:”leila@example.com”,”content”:”foo bar”,”created”:”2016-01-27T15:17:10.375877″}’
2、反序列化
from django.utils.six import BytesIO from rest_framework.parsers import JSONParser stream = BytesIO(json) data = JSONParser().parse(stream) # 解析json格式 serializer.is_valid() # True serializer.validated_data
3、保存實例
可以利用.create()和.update()方法
調用.save()方法會執行上面兩個方法，自動保存或者更新實例對象
有時候，需要保存其他的信息，可以在參數中添加，如：
serializer.save(owner=request.user)
4、驗證validation
當需要保存反序列化的數據時，我們往往需要在之前用is_valid()驗證數據的合法性，如果不合法可以用
serializer.errors得到該錯誤信息。這個錯誤信息可以根據error_message來進行自定義
5、模型序列化ModelSerializer
模型序列化與字段序列化用法類似，只需在類的屬性Meta中指定相應的模型，就會根據模型自動生成相應的字段
class AccountSerializer(serializers.ModelSerializer):
class Meta:
model = Account
fields = (‘id’, ‘account_name’, ‘users’, ‘created’)
6、超鏈接模型序列化HyperlinkedModelSerializer
與模型序列化類似，只不過過了一個可鏈接的形式。
十、序列化字段serializer fields
1、核心參數
*read_only: 只讀形式，只能序列化到api輸出，不能被反序列化數據更新修改操作。默認False
*wirte_only: 只寫形式，只能被反序列化數據更新和創建，不能序列化表示。默認False
*required: 必須字段，通常出現在反序列化的過程中，該字段必須有值。默認True
*allow_null：是否允許為空，默認False
*default: 默認值，
*source：字段來源，為字段指定一個字段來源，如(source=’user.email’).
*validators: 合法性函數列表，支持django的ValidationError包。
*error_message: 一個錯誤信息的字典，包含null, blank, invalid, invalid_choice, unique等鍵值。
*label:一篇簡短的文本字符串,可以用作在HTML表單字段的名稱或其他描述性的元素
*help_text: 一個文本字符串,可以用作描述字段的HTML表單字段或其他描述性的元素。
*initial: 用於預先填充HTML表單字段的值。
*style: 字典的鍵-值對,可以用來控制渲染器應該如何呈現。
2、字段類型
*布爾字段BooleanField: BoolenField(defalut=True)
*字符字段StringField: CharField(max_length=None, min_length=None, allow_blank=False, trim_whitespace=True)
*郵箱字段EmailField: EmailField(max_length=None, min_length=None, allow_blank=False)
*正則字段RegexField: RegexField(regex, max_length=None, min_length=None, allow_blank=False)
*新聞標題字段SlugField：SlugField(max_length=50, min_length=None, allow_blank=False)
*URL地址字段 UrlField: URLField(max_length=200, min_length=None, allow_blank=False)
*UUID字段 UUIDField: UUIDField(format=’hex_verbose’) —“de305d54-75b4-431b-adb2-eb6b9e546013″
*文件路徑字段FilePathField：FilePathField(path, match=None, recursive=False, allow_files=True, allow_folders=False, required=None, **kwargs)
*IP地址字段IPAddressField：IPAddressField(protocol=’both’, unpack_ipv4=False, **options)
*數字型字段：IntegerField、FloatField、DecimalField
*時間和日期字段：DateTimeField：DateTimeField(format=None, input_formats=None)
DateField：
TimeField：
DurationField：
*選擇字段：ChoiceField
*文件字段：FileField：FileField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
ImageField：ImageField(max_length=None, allow_empty_file=False, use_url=UPLOADED_FILES_USE_URL)
*模型字段：ModelField：ModelField(model_field=<Django ModelField instance>)
*只讀字段：ReadOnlyField：
十一、字段關系serializer relations
多對一：ForeignKey
多對多: ManyToManyField
一對一：OneToOneField
1、api參考
tracks = serializers.StringRelatedField(many=True) # 字符串形式關系字段
tracks = serializers.PrimaryKeyRelatedField(many=True, read_only=True)# 主鍵形式關系字段
tracks = serializers.HyperlinkedRelatedField(many=True, read_only=True, view_name=’track-detail’) # 超鏈接形式關系字段
tracks = serializers.SlugRelatedField(many=True, read_only=True, slug_field=’title’) # 以小標題形式關系
track_listing = serializers.HyperlinkedIdentityField(view_name=’track-list’) # 超鏈接身份關系
2、嵌套關系
序列化類中可以直接引用其他序列化化類
十二、合法性驗證(Validation)
1、數據的唯一性UniqueValidator
在模型中，只需設置字段的unique=True就會在該字段自動生成改唯一性判斷
例:slug = SlugField(max_length=100, validators=[UniqueValidator(queryset=BlogPost.objects.all(), messsage=”)])
*queryset：模型數據對象集合
*message: 異常提示信息
2、數據字段的不重復性UniqueTogetherValidator
class Meta: validators = [ UniqueTogetherValidator( queryset=ToDoItem.objects.all(), fields=(‘list’, ‘position’) ) ] *queryset：模型數據對象集合 *fields: 字段的集合元祖 *message: 異常提示信息
十三、認證Authentication
1、設置認證方案
*可以在settings文件中配置DEFAULT_AUTHENTICATION_CLASSES：
REST_FRAMEWORK = {
‘DEFAULT_AUTHENTICATION_CLASSES’: (
‘rest_framework.authentication.BasicAuthentication’,
‘rest_framework.authentication.SessionAuthentication’,
)
}
*也可以在視圖中設置
(APIView)：
authentication_classes = (SessionAuthentication, BasicAuthentication) permission_classes = (IsAuthenticated,) (@api_view) @authentication_classes((SessionAuthentication, BasicAuthentication)) @permission_classes((IsAuthenticated,))
十四、權限
1、設置權限方案
*可以在settings文件中配置DEFAULT_PERMISSION_CLASSES
REST_FRAMEWORK = { ‘DEFAULT_PERMISSION_CLASSES’: ( ‘rest_framework.permissions.IsAuthenticated’, # ‘rest_framework.permissions.AllowAny’, ) }
*視圖中設置：
（APIView）
permission_classes = (IsAuthenticated,)
（@api_view）
@permission_classes((IsAuthenticated, ))
2、API引用
*AllowAny：允許任何
*IsAuthenticated：是否被認證
*IsAdminUser：是管理用戶
*IsAuthenticatedOrReadOnly：是被認證或者只讀
*DjangoModelPermissions：標准的django模型設置權限
*DjangoModelPermissionsOrAnonReadOnly：標准的django模型處理或者只讀權限
*DjangoObjectPermissions：相比模型權限，只提供queryset和get_queryset方法。
*自定義權限：
繼承BasePermission;
重寫：.has_permission(self, request, view)
.has_object_permission(self, request, view, obj)
十五、節流Trottling
限制請求量
1、設置節流方案
*可以在settings文件中配置DEFAULT_THROTTLE_CLASSES 和 DEFAULT_THROTTLE_RATES
‘DEFAULT_THROTTLE_CLASSES’: ( ‘rest_framework.throttling.AnonRateThrottle’, ‘rest_framework.throttling.UserRateThrottle’ ), ‘DEFAULT_THROTTLE_RATES’: { ‘anon’: ‘100/day’, ‘user’: ‘1000/day’ }
*可以在視圖中設置：
（APIView）
throttle_classes = (UserRateThrottle,)
（@api_view）
@throttle_classes([UserRateThrottle])
十六、過濾器Filtering
通常drf的默認的通用list視圖類要處理的是全部模型的查詢集合集，如果我們要指定結果集，
這就必須用到過濾器了。通常的方法是重寫get_queryset(self)方法。
例如：
# 根據用戶過濾
class PurchaseList(generics.ListAPIView): serializer_class = PurchaseSerializer def get_queryset(self): user = self.request.user return Purchase.objects.filter(purchase = user) # 根據url請求過濾 def get_queryset(self): username = self.kwargs[‘username’] return Purchase.objects.filter(purchaser__username=username) # 根據請求參數過濾同上 def get_queryset(self): queryset = Purchase.objects.all() username = self.request.query_params.get(‘username’, None) if username is not None: queryset = queryset.filter(purchaser__username=username) return queryset
1、generic filter過濾
*通過settings文件中配置過濾
REST_FRAMEWORK = {
‘DEFAULT_FILTER_BACKENDS’: (‘rest_framework.filters.DjangoFilterBackend’,)
}
*也可通過視圖中過濾
filter_backends = (filters.DjangoFilterBackend,)
2、API向導
*pip install django-filter
filter.DjangoFilterBackend
*filter_fields過濾字段
class ProductList(generics.ListAPIView): query = Product.object.all() serializer_class = ProductSerializer filter_backends = (filter.DjangoFilterBackend,) filter_fields = (‘category’, ‘in_stock’) http://example.com/api/products?category=clothing&in_stock=True *filter_class指定一個過濾集合類 import django_filters from myapp.models import Product from myapp.serializers impoert ProductSerializer from rest_framework import filters from rest_framework import generics class ProductFilter(filters.FilterSet): min_price = django_filters.NumberFilter(name=’price’, lookup_type=”gte”) max_price = django_filters.NumberFilter(name=’price’, lookup_type=”lte”) class Meta: model = Product fields = [‘category’, ‘in_stock’, ‘min_price’, ‘max_price’] class ProductList(generics.ListAPIView): queryset = Product.object.all() serializer_class = ProductSerializer filter_backends = (filter.DjangoFilterBackend,) filter_class = ProductFilter http://example.com/api/products?category=clothing&max_price=10.00 同理雙下划線強調名字： class ProductFilter(filters.FilterSet): class Meta: model = Product fields = [‘category’, ‘in_stock’, ‘manufacturer__name’] http://example.com/api/products?manufacturer__name=foo 上面例子等同於： class ProductFilter(filter.FilterSet): manufacturer = django_filters.CharFilter(name=”manufacter__name”) class Meta: model = Product fields = [‘category’, ‘in_stock’, ‘manufacturer’] http://example.com/api/products?manufacturer=foo *search_fields 搜索字段 class UserListView(generics.ListAPIView): queryset = User.object.all() serializer = UserSerializer filter_backends = (filter.SearchFilter,) filter_fields = (“suername”, ’email’) http://example.com/api/users?search=russell *ordring_fields排序字段 class UserList(generics.ListAPIView): queryset = User.object.all() serializer_class = UserSerializer filter_backends = (filter.OrderingFilter,) filter_fields = ‘__all__’ ordering = (‘username’,) # 默認排序字段 *DjangoOjectPermissionFilter 對象權限的過濾器 filter_backends = (filter.DjangoObjectPermissionFilter,) permission_classes = (myapp.permissions.CustomObjectPermissions,) # 自定義的權限類
十七、分頁Pagination
1、設置分頁
*可以在settings中設置分頁樣式
REST_FRAMEWORK = {
‘DEFAULT_PAGINATION_CLASS’: ‘rest_framework.pagination.LimitOffsetPagination’
}
*修改分頁樣式
class LargeResultsSetPagination(PageNumberPagination): page_size = 1000 page_size_query_param = ‘page_size’ max_page_size = 10000 class StandardResultsSetPagination(PageNumberPagination): page_size = 100 page_size_query_param = ‘page_size’ max_page_size = 1000
*應用到視圖中
class BillingRecordsView(generics.ListAPIView): queryset = Billing.objects.all() serializer = BillingRecordsSerializer pagination_class = LargeResultsSetPagination
2) API引用
*PageNumberPagination
設置全局的分頁大小：
REST_FRAMEWORK = { ‘DEFAULT_PAGINATION_CLASS’: ‘rest_framework.pagination.PageNumberPagination’, ‘PAGE_SIZE’: 100 }