REST框架中的视图

(关于REST框架,我在序列化和反序列化已经介绍过来,这里就不再重复说明)

当我们使用REST框架的时候,视图就由原本的View升级为了APIView, 继承自Django的View

在原来继承django.view.View的时候

  • 如果是get数据,通过request.GET来获取数据
  • 如果是post数据,通过request.POST来获取数据
  • 如果是post传来的json数据,通过request.body来获取数据

再介绍REST框架封装的视图前,先介绍它里面的Request和Response

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.POSTrequest.FILES属性,但提供如下特性:

  • 包含了解析之后的文件和非文件数据
  • 包含了对POST、PUT、PATCH请求方式解析后的数据
  • 利用了REST framework的parsers解析器,不仅支持表单类型数据,也支持JSON数据

再使用REST中的Request对象的时候,原来的get,post这些请求还是可以用的。因为APIView继承自view
使用起来也非常便利,比如以前要data = json.loads(request.body.decode())获取json数据,现在只要request.data即可

2).query_params

request.query_params与Django标准的request.GET相同,只是更换了更正确的名称而已。

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: 为响应准备的序列化处理后的数据,这个数据一般是我们进行序列化器序列化之后的,data也可以是基本数据类型:[],{},string;
  • status: 状态码,默认200;
  • template_name: 模板名称,如果使用HTMLRenderer时需指明;
  • headers: 用于存放响应头信息的字典;
  • content_type: 响应数据的Content-Type,通常此参数无需传递,REST framework会根据前端所需类型数据来设置该参数。

常用属性

1).data

传给response对象的序列化后,但尚未render处理的数据

2).status_code

状态码的数字

状态码

为了方便设置状态码,REST framewrok在rest_framework.status模块中提供了常用状态码常量。

信息告知 - 1xx
HTTP_100_CONTINUE
HTTP_101_SWITCHING_PROTOCOLS
View Code
成功 - 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_STATUS
View Code
重定向 - 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_REDIRECT
View Code
客户端错误 - 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_REASONS
View Code
服务器错误 - 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
View Code

视图

APIView(一级封装)

rest_framework.views.APIView

APIView是REST framework提供的所有视图的基类,继承自Django的View父类。

APIViewView的不同之处在于:

  • 传入到视图方法中的是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)

总结

其实这里看到的APIView相比于之前的View,最明显的就是Request对象和Respons对象的使用和作为REST框架视图的基类。


要用serializer.data获取数据,必须要进行校验之后。

GenericAPIView(二级封装)

文档

rest_framework.generics.GenericAPIView

继承自APIVIew,增加了对于列表视图和详情视图可能用到的通用支持方法。通常使用时,可搭配一个或多个Mixin扩展类。关于Mixin会在后面专门介绍。

使用GenericAPIView类一般需要实现queryset属性或者重写get_queryset方法

支持定义的属性:
  • 列表视图与详情视图通用:
    • 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.user
          return 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,这三个数据对象可以在定义序列化器时使用。

      • request是当前视图方法中的request对象
      • format代表格式类型,就是前端请求数据的格式。
      • view当前类视图的对象
        • 能够通过类视图执行到下面的get,post这样的方法,是先创建这个类对象,然后使用它的分发方法,才进入到对应的请求方法中去的。在序列化器中,我们可以用self.context['view'](上面的两个同理)获取这个类对象。在django的类视图中,由于是根据请求触发的,那么类对象就会解析出来请求中的参数,那它不仅会将请求的参数传给分发的方法中,还会直接保存到类视图对象中,作为类视图中的一个属性kwargs的值,那么kwargs属性中就保存了路径中提取出来的参数。在序列化器中取值的时候就可以这样,比如:self.context['view'].kwargs['mobile']
  • 详情视图使用:

    • 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)

总结

  • GenericAPIView继承自APIView,它是对APIView的进一步封装
  • serializer_class=自定义序列化器,可以用来绑定一个序列化器,这样就规定了这个类中使用的序列化器(需要说明的是这并不表示在类中不可以用其他的序列化器),创建序列化器对象的时候可以用self.get_serializer()来获取在这个类中绑定的序列化器。
  • queryset,在GenericAPIView中除了serializer_class还有一个queryset属性,相当于让它获取以后要操作的数据,比如:queryset = BookInfo.objects.all()
  • 在GenericAPIView中有一个get_object()这个方法,是GenericAPIView抽取的方法,它根据传递给视图的pk值来从queryset中筛选然后获取数据,如果不想用pk值作为筛选条件,可以用lookup_field来修改,比如 lookup_field="id"这样就是根据传递的id来获取数据
  • 到目前为止,可以看到,虽然封装了两层,好像并没有让我们获得真正的便利,这是因为GenericAPIView只有和一个或者多个Mixin拓展类搭配才能显示它的好处。

Mixin

rest_framework.mixins

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 ListModelMixin
from rest_framework.generics import GenericAPIView

class ListModelView(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 {}
源代码

举例:

from rest_framework.mixins import CreateModelMixin

class ListModelView(CreateModelMixin,GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def post(self,request):
        return self.create(request)

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 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)

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)
源代码

举例:

from rest_framework.mixins import UpdateModelMixin

class ListModelView(UpdateModelMixin,GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def put(self,request,pk):
      return  self.update(request)

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()
源代码

举例:

from rest_framework.mixins import DestroyModelMixin

class ListModelView(DestroyModelMixin,GenericAPIView):
    queryset = BookInfo.objects.all()
    serializer_class = BookInfoSerializer

    def delete(self,request,pk):
        return self.destroy(request)

总结

从上面的例子可以看出来,只要我们在类中将queryset和serializer_class赋上对应的值,然后挑选需要的Mixin拓展类,写上对应的方法,就完成了以前需要重复书写的代码。

子类视图(三级封装)

还有一种三级的封装方式,它是将GenericAPIView和Minxin中的一些类进行了封装

rest_framework.generics

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

由于举例的话基本一样,这里就举一个例子,例子中还有需要注意的问题。

from rest_framework.generics import ListAPIView

class BookListAPIView(ListAPIView):

    # 继承自 ListAPIView 就可以返回 所有数据

    # 序列化器从哪里来
    # serializer_class = BookSerializer
    #或者
    def get_serializer_class(self):

        return BookSerializer

    # 数据从哪里来
    # queryset = BookInfo.objects.all()
    # 或者
    def get_queryset(self):

        return BookInfo.objects.all()
    pass
View Code

视图集

viewset

rest_framework import viewsets

文档

引子

有这样一个实际的简单的例子在这里提一下

比如:

有一个视图用于实现获取所有数据,增加数据

 get ————》获取所有书籍

post————》增加书籍

还有一个视图用于实现获取书籍详情,修改书籍信息,删除书籍

get————》获取书籍信息

put————》修改一本书

delete————》删除一本书

可以看到,一共有两个get方法,他们的操作差不多,,那能不能把它俩融合一下。

正文

Django REST框架允许将一组相关视图的逻辑组合到一个类中,称为ViewSet

一个ViewSet类只是一种基于类的View,它不提供任何方法处理程序(如get()orpost()),而是提供诸如list()create()之类的操作。

使用ViewSet类比使用View类有两个主要优点。

  • 重复的逻辑可以合并成一个类。例如我们只需要指定queryset一次,它将用于多个视图。
  • 通过使用路由器,我们不再需要处理自己的URL配置

那么这是什么意思呢?

详细的解释,看上面给出的文档,里面给出了详细的用法。这里只对里面的内容进行简单的说明:

我们可以定义一个类,继承自viewsets.ViewSet,里面有两个方法,分别是list和retrieve,分别是对列表视图和详情视图的处理,这样在类中queryset和serializer_class只用定义一次就可以了。

重构了这个类之后,再将url进行相应的修改:

方案一:

from django.conf.urls import url,include
from book.views import BookViewSet

urlpatterns = [

    url(r'^books/$',BookViewSet.as_view({'get': 'list'})),
    url(r'^books/(?P<pk>\d+)/$',BookViewSet.as_view({'get': 'retrieve'})),
]
View Code

方案二:

rom rest_framework.routers import DefaultRouter

rounter = DefaultRouter()
rounter.register(r'books',views.BookViewSet,base_name='')


urlpatterns = [
   
]

urlpatterns += rounter.urls
View Code

视图集为我们定义了这样几种请求的处理方式:

class BookViewSet(viewsets.ViewSet):

    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
View Code

 

一个ViewSet类同时提供以下可用属性

  • basename- 用于创建的URL名称的基础。
  • action- 当前动作的名称(例如listcreate)。
  • detail- 布尔值,指示当前操作是否为列表或详细视图配置。
  • suffix- 视图类型的显示后缀 - 镜像detail属性。

例如:

from rest_framework.viewsets import ViewSet
from django.shortcuts import get_object_or_404
from rest_framework.response import Response

class BookViewSet(ViewSet):

    def list(self,request):
        queryset = BookInfo.objects.all()
        serializer = BookInfoSerializer(queryset,many=True)
        return Response(serializer.data)

    def retrieve(self,request,pk=None):
        queryset = BookInfo.objects.all()
        user = get_object_or_404(queryset, pk=pk)
        serializer = BookInfoSerializer(user)
        return Response(serializer.data)
View Code

 

总结:视图集并没有为我们编写任何代码,只不过是换了一种分发的方式,我们可以在一个视图中定义两种get请求(通过上面说的,用url进行分发):list(获取多个模型类),retrieve(获取单个模型类)。这样。而且在ViewSet这个基类的视图级中,应该注意到,它分发的几个方法,和Mixin的几个拓展的方法非常的像。所有在后面的下一级封装,肯定会做些什么。

GenericViewSet

继承自GenericAPIView,作用也与GenericAPIVIew类似,提供了get_object、get_queryset等方法便于列表视图与详情信息视图的开发

ModelViewSet

我们进入ModelViewSet看看它内部到底是什么?

一进去,就可以豁然开朗了,这些再mixin里面是看到过的。ModelViewSet是对mixin的一些类和GenericViewSet的封装。

也就是说,只要我们在类中将queryset和serializer_class定好,再修改路由就可以了把增删改查完成了,这样在浏览器中输入对应的网址即可完成增删改查。

# views.py中定义个继承自ModelViewSet的类
Class BookViewModel(ModelViewSet):
    queryset = BookInfo.objects.all()
    serializer_class = BookSerializer

# 在url.py中,关于这个DefaultRouter会在后面说明,这些内容就是自动生成路由。
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register(r'books', views.BookViewModel, base_name="book")
urlPatterns += router.urls
View Code

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'})),
]
View Code

注:这个action是给后面说的Router看的。

路由Router

REST framework提供了两个router,这两个都可以帮助我们自动生成路由。

  • SimpleRouter
  • DefaultRouter

使用方法

1) 创建router对象,并注册视图集,注册语法为

register(prefix, viewset,base_name)
  • prefix 该视图集的路由前缀
  • viewset 视图集
  • base_name 路由名称的前缀

例1:

from rest_framework import routers

router = routers.SimpleRouter()
router.register(r'books', BookViewSet, base_name='book')

如上述代码会形成的路由如下:

列2:

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-read

路由router形成URL的方式

1) SimpleRouter

 2)DefaultRoute

 

 注:DefaultRouter与SimpleRouter的区别是,DefaultRouter会多附带一个默认的API根视图,返回一个包含所有列表视图的超链接响应数据。

添加路由数据

可以有两种方式:

urlpatterns = [
    ...
]
urlpatterns += router.urls

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

 问题

1)

DefaultRouter和SimpleRouter的共同点是都能生成路由
DefaultRouter和SimpleRouter的区别是:
DefaultRouter:提供了根路由:比如http://127.0.0.1:8080后,有内容
SimpleRouter:没有提供根路由,比如http://127.0.0.1:8080后,为404
2)
视图集的url是自动生成的,是有局限的,我们无法从url中获取需要的数据

rest中想到了这个问题,提供了一个装饰器为我们拓展方法

from rest_framework.decorators import action

action(method,detail)
method表示http的动词方法
detail = True 表示详情视图添加方法,ulr的生成规则是,url的生成规则是books/pk/方法名
detail = False 表示添加列表方法, url的生成规则是books/方法名
比如:

例1:

例2:


虽然如此,但是还是不灵活,所以了解即可

 

posted @ 2018-07-02 16:39  苦行僧95  阅读(329)  评论(0)    收藏  举报