如何在没有任何模型的情况下使用Django REST框架的视集通过POST方法在Swagger UI中传递参数？ [英] How to pass parameters in Swagger UI with a post method using viewsets with Django Rest Framework without any model?

问题描述

我需要做一个API来创建某种逻辑(例如：处理一些数据、生成一个词云、创建一个ML层……)并返回一个简单状态。在我想要做的逻辑中，我不需要模型，只需要接收一个带有一些参数的json，然后做我想做的事情。

我刚刚创建了API视图，但找不到在Body中接收参数的方法。

我读到了一个很好的模式来设计我的方法(Django Rest Framework Business Logic，Separation 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是空的。即使在夸张的用户界面中，我也看不到发送我的json的参数标签。

我找到的所有示例都使用模型和序列化程序。

一个接收并返回"Hello"+名称的简单Api视图，对我来说就足够了。

如何在不使用模型的情况下通过POST请求在WordCloudViewSet中指定输入参数？

感谢您查看，并提前感谢您的回复。

编辑

令人惊讶的是，我没有尝试过request.data，而且它起作用了。但是，在swagger UI中，我不能在注释previosluy时测试我的API，因为它没有显示用于发送请求的输入标签。

推荐答案

最后，我找到了一个简单的解决方案，我只需更改URL，如下所示：

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')
]

然后在swagger中显示参数的标签：

其他信息 对于其他有同样问题的人的另一个建议是，我更喜欢使用序列化程序，即使我不需要使用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)

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

这篇关于如何在没有任何模型的情况下使用Django REST框架的视集通过POST方法在Swagger UI中传递参数？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！