django rest框架中模型的多种类型的更新操作

时间:2017-01-29 14:14:40

标签: python django django-rest-framework django-rest-viewsets

Follwing是我的模特

class Group(Log_Active_Owned_Model_Mixin):

    group_name = SafeCharField(max_length = 100, null=False, blank=False, sanitize_cb=safe_name_sanitizer)
    group_creator = ForeignKey(to=PSS_User, null=False, related_name="group_creator")
    members = ManyToManyField(to=PSS_User, through="GroupMemberShip", related_name="group_member")

    class Meta:
        ordering = ("Meta", )

    ## other methods also exists in this class.

class GroupMemberShip(Log_Active_Owned_Model_Mixin, ResolvableModelMixin):

    MEMBER_NONE     = 1
    MEMBER_ADMIN    = 2
    MEMBER_STANDARD = 4


    VALID_MEMBERSHIPS = (
        (MEMBER_ADMIN,      "Admin"     ),
        (MEMBER_STANDARD,   "Standard"  ),
        (MEMBER_NONE,       "None"      )
    )

    member  = ForeignKey(to=PSS_User, null=False, related_name="groups")
    group   = ForeignKey(to=Group, null=False, related_name="members")
    membership_type     = SmallIntegerField(editable=False, null=False, blank=False, choices=VALID_MEMBERSHIPS)
    membership_request  = ForeignKey(to=GroupMemberShipRequest, null=True, blank=True)  # null True for group creator

    class Meta:
        ordering = ("date_created")
        unique_together = ("member", "group")

    ## other methods also exists in this class.

class GroupMemberShipRequest(Log_Active_Owned_Model_Mixin):

    GRP_MEMBERSHIP_REQ_STATUS_ACCEPTED  = 1
    GRP_MEMBERSHIP_REQ_STATUS_REJECTED  = 2
    GRP_MEMBERSHIP_REQ_STATUS_PENDING   = 4

    VALID_REQUEST_STATUSES = (
        (GRP_MEMBERSHIP_REQ_STATUS_ACCEPTED,    "Accepted"),
        (GRP_MEMBERSHIP_REQ_STATUS_REJECTED,    "Rejected"),
        (GRP_MEMBERSHIP_REQ_STATUS_PENDING,     "Pending")
    )

    #   TODO :-
    #   Add a field in request-type. There are two types of requests :-
    #   User can request admin to include him in the request.
    #   Admin can request other user, to become part of given group.

    GRP_REQUEST_ACTIVE  = 1
    GRP_REQUEST_PASSIVE = 2

    VALID_GRP_REQUESTS = (
        (GRP_REQUEST_ACTIVE,    "Active"),
        (GRP_REQUEST_PASSIVE,   "Passive")
    )

    request_initiator = ForeignKey(to=PSS_User, null=False, blank=False)
    request_acceptor_rejector = ForeignKey(to=PSS_User, null=True, blank=False)
    request_status  = SmallIntegerField(null=False, editable=False, choices=VALID_REQUEST_STATUSES, default=GRP_MEMBERSHIP_REQ_STATUS_PENDING)
    target_group = ForeignKey(to=Group, null=False, blank=False, related_name="members")
    request_type = SmallIntegerField(null=False, editable=False, default=GRP_REQUEST_ACTIVE, choices=VALID_GRP_REQUESTS)

以下是不同类型的操作,使用此组模型可以实现: -

  • 创建群组
  • 更新群组
    1. 更新群组详情。
    2. 添加/删除群组成员
    3. 向局外人发送邀请
    4. make admin / remove admin。
      • 删除群组

对于创建/删除操作,事情很清楚,但我对更新操作感到困惑,因为有很多事情可以更新。目前,我在Group类中添加了辅助方法,它完成了上述所有活动。

我的问题是,如何将其与DRF(Django Rest Framework)ModelViewSets集成。由于只有一个update()方法,它只能提供上述更新方案之一。我如何处理其他更新场景?(一个可能的解决方案,我认为在请求中使用操作类型标志并在update()方法中检查它,以决定调用哪个模型方法,但它有点天真的解决方案。有没有更好的方法在Django Rest Framework中执行此操作?)

提前致谢。

1 个答案:

答案 0 :(得分:1)

考虑一下这篇文章Best Practices for Designing a Pragmatic RESTful API

  

将其视为具有RESTful原则的子资源。例如,GitHub的API允许您使用PUT / gists /:id / star和unstar与DELETE / gists /:id / star加注。

在你的情况下,一组有4种不同的动作。我在DRF中看到了解决它的两种方法。按照上面的提示,您可以使用@detail_route装饰器:

from rest_framework.decorators import detail_route

class GroupViewSet(viewsets.ModelViewset):

    @detail_route(methods=['put', 'delete'])
    def send_invite(self, request, pk=None):
        # check for the method provided 
        # do your logic and return a Response object
        pass

它会在详细信息页

之后的视图集路由器中添加其他端点
/api/groups/:id/send_invite/

它可以很好地完成简单的任务。但是当你需要一个复杂的嵌套逻辑时,你会发现这个包有用drf-nested-routers。它允许您相互构建视图。

/api/groups/:id/admin/:id/

但有时它有点矫枉过正,它违反了设计API的最佳实践