文章目录
一、Django 路由
Django REST framework 增加了对 Django 自动 URL 路由的支持。
from rest_framework import routers
router = routers.SimpleRouter()
router.register(r'users', UserViewSet)
router.register(r'accounts', AccountViewSet)
urlpatterns = router.urls
register() 方法有两个必须参数:
- prefix - 设置这组路由的前缀。
- viewset - 设置对应的视图集类。
或者,您也可以指定一个附加参数:
base_name - 用于创建的 URL 名称的基础。如果未设置,将根据视图集的 queryset 属性自动生成。请注意,如果视图集不包含 queryset 属性,则在注册视图集时必须设置 base_name。
上面的例子会生成以下 URL 模式:
- URL pattern: ^users/$ Name: ‘user-list’
- URL pattern: ^users/{pk}/$ Name: ‘user-detail’
- URL pattern: ^accounts/$ Name: ‘account-list’
- URL pattern: ^accounts/{pk}/$ Name: ‘account-detail’
用 @detail_route 或 @list_route 装饰的 视图上的任何方法 也将被路由。
from myapp.permissions import IsAdminOrIsSelf
from rest_framework.decorators import detail_route
class UserViewSet(ModelViewSet):
...
@detail_route(methods=['post'], permission_classes=[IsAdminOrIsSelf])
def set_password(self, request, pk=None):
...
会生成以下URL模式:
- URL pattern: ^users/{pk}/set_password/$ Name: ‘user-set-password’
自定义操作的URL
如果您不想使用默认生成的 URL 模式,则可以使用 url_path 参数对其进行自定义。
例如,如果您想将我们的自定义操作的URL更改为 ^users/{pk}/change-password/$,则可以编写:
from myapp.permissions import IsAdminOrIsSelf
from rest_framework.decorators import detail_route
class UserViewSet(ModelViewSet):
...
@detail_route(methods=['post'], permission_classes=[IsAdminOrIsSelf], url_path='change-password')
def set_password(self, request, pk=None):
...
上面的例子现在将生成以下URL模式:
URL pattern: ^users/{pk}/change-password/$ Name: ‘user-change-password’
二、Django 基础-各种view,viewset (ReadOnlyModelViewSet)
全部更新
XXX.objects.all().update(country='USA')
update()方法会返回一个整型数值,表示受影响的记录条数
update()方法对于任何结果集(QuerySet)均有效,这意味着你可以同时更新多条记录。
全部更新,我们使用 XXX.objects.all() 去更新即可
根据界面传的主键id批量更新demo
@list_route(methods=['post'])
def batch_delete(self, request, *args, **kwargs):
response_data = {'errCode': 0, 'msg': 'Success'}
ids = self.request.data.get('ids',None)
if ids is None:
raise serializers.ValidationError({'message': [_("ids不能为空")]})
Xxx.objects.filter(id__in=ids).update(columname1=0,cloumname2=True)
return HttpResponse(json.dumps(response_data), content_type="application/json")
如上所示,使用Xxx.objects.filter()方法过滤即可, 更新多个字段时,直接使用逗号隔开,如 columname1=0,cloumname2=True。
前端传参
{
"ids": [
11,
15,
16,
17
]
}
@list_route指定浏览器使用的具体http方法
rest_framework 中对于自定义的 viewset 方法提供了两种装饰器
- list_route
- detail_route
区别就是 list_route 的参数不包含 pk(对应 list),而 detail_route 包含pk(对应 retrieve)
@list_route(methods=['post', 'delete'])
def custom_handler(self, request):
pass
@detail_route(methods=['get'])
def custom_handler(self, request, pk=None):
pass
我们使用 @list_route 直接指定了浏览器可以使用http方法。
三、参考
Django-批量更新
参考URL: https://www.cnblogs.com/songzhixue/articles/11064985.html
Django REST framework API 指南(6):路由
参考URL: https://blog.csdn.net/weixin_34082177/article/details/87985065