如何在不使用任何模型的情况下使用带有Django Rest Framework的视图集的post方法在Swagger UI中传递参数?

时间:2019-09-07 22:15:03

标签: python-3.x django-rest-framework django-views swagger-ui

我需要做一个api来进行某种逻辑处理(例如:处理一些数据,生成wordcloud,创建一个ml层...)并返回一个简单的状态。按照我想做的逻辑,我不需要模型,只需要接收带有一些参数的json即可完成我想做的事情。

我刚刚创建了api视图,但找不到在体内接收参数的方法。

我正在阅读一种设计我的方法的好模式(Django Rest Framework Business LogicSeparation of business logic and data access in django),并且我在api.py文件中编写了代码。我没有为此视图使用序列化器,因为我不需要使用模型中的数据,而是使用输入json。

api.py

from rest_framework import viewsets
from rest_framework import views
from rest_framework import status
from rest_framework.response import Response
from rest_framework_swagger.views import get_swagger_view

class WordCloudViewSet(viewsets.ViewSet):

    def create(self, request, *args, **kwargs):
        comments_list = kwargs['data']['comments']
        user_id = kwargs['data']['user_id']
        '''
        some logic
        '''
        return Response(status=status.HTTP_200_OK)

urls.py

from django.conf.urls import include, url
from rest_framework import routers
from .api import (WordCloudViewSet)
from api import views

router = routers.DefaultRouter()

schema_view = get_swagger_view(title='Swagger Documentation')

urlpatterns = [
    url(r'^api/wordcloud/', WordCloudViewSet.as_view({'get': 'list', 'post':'create'}), name='wordcloud')
]

urlpatterns += router.urls

我尝试通过邮递员的身体发送json,例如:

{
    "data": {
        "comments": ["Lorem ipsum dolor sit amet"],
        "user_id": 1
    }
}

但是args和kwargs空了。即使在宽大的UI中,我也看不到参数标签来发送我的json。

enter image description here

我发现的所有示例都使用模型和序列化器。

一个简单的Api View接收a并返回“ Hello” +名称,对我来说就足够了。

如何在WordCloudViewSet中指定通过发布请求输入参数而无需使用模型?

感谢您的配合,并感谢您的回复。

修改

令人惊讶的是,我没有尝试使用request.data并且它可以工作。但是,在宽大的UI中,我在评论previosluy时无法测试我的api,因为它没有显示输入标签来发送请求。

1 个答案:

答案 0 :(得分:0)

最后,我找到了一个简单的解决方案,我只需要更改网址:

urlpatterns = [
    url(r'^api/wordcloud/', WordCloudViewSet.as_view({'get': 'list', 'post':'create'}), name='wordcloud')
]

对此:

urlpatterns = [
    url(r'^api/wordcloud/comments/<string:comments>/user_id/<int:user_id>', WordCloudViewSet.as_view({'get': 'list', 'post':'create'}), name='wordcloud')
]

然后摇摇晃晃地显示参数标签:enter image description here

附加信息 对于具有相同问题的任何其他人的另一个建议是,即使我不需要使用来自Model的数据,我也更喜欢使用序列化程序,仅用于必需和可选参数验证:

serializers.py

class WordCloudAPISerializer(serializers.ModelSerializer):
    comments = serializers.CharField(required=True)
    user = serializers.IntegerField(source='id',required=False)
    class Meta:
        model = User
        fields = ('comments','user')

    def to_internal_value(self, data):
        required = []
        optionals = []
        for k in ['comments']:
            '''
            - Case 1: Is the k field in the data and it's empty?
            - Case 2: Is not the k field in the data?
            '''
            if (data.keys().__contains__(k) and data[k] == '') or (not data.keys().__contains__(k)):
                required.append(k)

        for k in ['user']:
            # Is not the k field in the data?
            if not data.keys().__contains__(k):
                optionals.append(k)

        if len(required) > 0 and len(optionals) > 0:
            raise ValueError("The following fields are required: %s" % ','.join(required) + " and the following fields are needed but can be empty: %s" % ','.join(optionals))

        elif len(required) > 0 and len(optionals) == 0:
            raise ValueError("The following fields are required: %s" % ','.join(required))

        elif len(required) == 0 and len(optionals) > 0:
            raise ValueError("The following fields are needed but can be empty: %s" % ','.join(optionals))

        return data

然后在 api.py

            serializer = WordCloudAPISerializer(data=kwargs['data'])
            if serializer.is_valid():
                '''some logic'''
            else:
                return Response(serializer.errors,status=status.HTTP_400_BAD_REQUEST)

我希望这对其他任何人都有用。