如何让JSON API返回可浏览API表单中的用户专属查询结果？

方法一：在创建/更新接口的响应中附加选项数据 #

你可以在ViewSet的对应动作方法里，或者序列化器的to_representation方法中，把过滤后的用户选项数据添加到响应结果里。

方式1：修改ViewSet的动作方法 #

在create或update方法执行完成后，追加选项数据：

class OrganizationInviteViewSet(viewsets.ModelViewSet):
    # 保留原有的get_serializer_class等代码
    def create(self, request, *args, **kwargs):
        response = super().create(request, *args, **kwargs)
        # 获取过滤后的用户查询集
        invitee_serializer = OrganizationInviteeSerializer(context={'request': request})
        allowed_users = invitee_serializer.get_queryset().values('id', 'username')  # 按需返回字段
        response.data['allowed_users'] = list(allowed_users)
        return response
    
    def update(self, request, *args, **kwargs):
        response = super().update(request, *args, **kwargs)
        invitee_serializer = OrganizationInviteeSerializer(context={'request': request})
        allowed_users = invitee_serializer.get_queryset().values('id', 'username')
        response.data['allowed_users'] = list(allowed_users)
        return response

方式2：通过序列化器的to_representation方法 #

重写OrganizationInviteStoreSerializer的to_representation，序列化时自动附加选项：

class OrganizationInviteStoreSerializer(serializers.ModelSerializer):
    user = OrganizationInviteeSerializer(many=False, allow_null=True)

    class Meta:
        model = OrganizationInvite
        fields = ['id', 'user', ...]  # 填写你的其他字段

    def to_representation(self, instance):
        data = super().to_representation(instance)
        # 获取当前请求用户可访问的用户选项
        invitee_qs = OrganizationInviteeSerializer(context=self.context).get_queryset()
        data['allowed_users'] = [{'id': user.id, 'username': user.username} for user in invitee_qs]
        return data

方法二：新增独立API端点返回可选用户列表 #

创建单独视图返回当前用户可邀请的用户列表，前端可按需主动请求：

# 在views.py中
from rest_framework.decorators import action
from rest_framework.response import Response

class OrganizationInviteViewSet(viewsets.ModelViewSet):
    # 保留原有的代码
    @action(detail=False, methods=['get'])
    def allowed_invitees(self, request):
        serializer = OrganizationInviteeSerializer(context={'request': request})
        allowed_users = serializer.get_queryset().values('id', 'username')
        return Response({'allowed_users': list(allowed_users)})

注册路由后，接口路径为/organization-invites/allowed-invitees/，前端可单独调用获取选项。

最佳实践 #

• 分离关注点：若选项数据复杂或需多接口复用，优先用独立端点，避免创建/更新接口响应臃肿。
• 复用权限逻辑：直接复用OrganizationInviteeSerializer的get_queryset方法，避免重复代码和权限漏洞。
• 精简返回字段：只返回前端必需的标识字段（如id、username），减少数据传输量。
• 缓存优化：若可邀请列表变动不频繁，用Django缓存框架缓存查询结果，降低数据库压力。
• 分页处理：若过滤后用户数量多，对结果分页，避免一次性返回大量数据影响性能。

内容的提问来源于stack exchange，提问作者Crag