ViewSet 主要是用来解决 APIView 中,要求 函数名必须是请求名的问题
在 ViewSet 可以用任意的函数作为 请求的 函数,只需要在
定义路由的时候,在 as_view 中,指定 请求方法 和 函数 的对应关系即可
还解决了 在同一类中,只能定义 一个 get 请求方法
class UserViewSet(ViewSet):
def list(self, request):
# 查询所有数据
pass
def create(self, request):
# 新增数据
pass
定义路由:
path('users', views.UserViewSet.as_view({"get":"list", "post":"create" }))
混合视图
from rest_framework.mixins import -ListModelMixin, CreateModelMixin , RetrieveModelMixin, UpdateModelMixin, DestroyModelMixin
-ListModelMixin
-CreateModelMixin
-RetrieveModelMixin
-UpdateModelMixin
-DestroyModelMixin
混合视图 内置了一系列的方法,例如 list, create, retrieve, update, destroy
混合适合 需要 和 GenericViewSet 配合使用
代码示例:
class UserView(ListModelMixin, CreateModelMixin,
RetrieveModelMixin, UpdateModelMixin,
DestroyModelMixin,
GenericViewSet):
queryset = User.objects.all()
serializer_class = UserSerializer
定义路由
path('users', views.UserView.as_view({"get":"list", "post":"create"}), name="user-list"),
url('users/(?P<pk>\d+$)', views.UserView.as_view({"get":"retrieve", "put": "update", "delete":"destroy"}), name="user-detail"),
在 ViewSet 中, 可以定义一个router,用来替代传统的路由定义
新建一个 routers.py
,代码如下
from rest_framework.routers import DefaultRouter
router = DefaultRouter()
router.register('user', views.UserView)
在路由urls.py
中进行管理
from .routers import router
urlpatterns = [
url('^', include(router.urls))
...
...
]
router.urls 返回的结果如下格式:
[
<URLPattern '^user/$' [name='user-list']>,
<URLPattern '^user\.(?P<format>[a-z0-9]+)/?$' [name='user-list']>,
<URLPattern '^user/(?P<pk>[^/.]+)/$' [name='user-detail']>,
<URLPattern '^user/(?P<pk>[^/.]+)\.(?P<format>[a-z0-9]+)/?$' [name='user-detail']>,
<URLPattern '^$' [name='api-root']>,
<URLPattern '^\.(?P<format>[a-z0-9]+)/?$' [name='api-root']>
]
ViewSet 在使用的时候
get : 默认对应 list , retrieve
post : 默认对应create
put : 默认对应update
delete :默认对应 destory
在 ViewSet 中, 自定义一个函数、如何让 DefaultRouter 识别
在 ViewSet 中, 通过 一个 @action 装饰器,装饰某个函数,就可以让 DefaultRouter识别
@action 装饰中,常见的属性有:
- methods : 代表请求方式、是一个列表,可以设置多个
- detail : True/False : True在路由上会设置一个 pk,要求根据 主键进行数据查询,False则和主键没有关系
- url_path : 设置请求路径 , 相当于 path函数中 router
- url_name : 设置请求路由对应的名字,相当于 path函数中 name
detail=False
<URLPattern '^user/login/$' [name='user-login']>,
detail=True
<URLPattern '^user/(?P<pk>[^/.]+)/login/$' [name='user-login']>,
ModelViewSet / ReadOnlyModelViewSet
ModelViewSet 继承了
mixins.CreateModelMixin,
mixins.RetrieveModelMixin,
mixins.UpdateModelMixin,
mixins.DestroyModelMixin,
mixins.ListModelMixin,
GenericViewSet
ReadOnlyModelViewSet 继承了
mixins.RetrieveModelMixin,
mixins.ListModelMixin,
GenericViewSet