django rest 框架 - 如何将 post 参数添加到 api 文档（drf_yasg）？

Question

x_param = openapi.Parameter('x', in_=openapi.IN_FORM, description='srring',
                                   type=openapi.TYPE_STRING)

y_param = openapi.Parameter('y', in_=openapi.IN_FORM, description='string',
                                   type=openapi.TYPE_STRING)

@swagger_auto_schema(method='post', manual_parameters=[x_param,y_param])
@api_view(['POST'])
def test(request):
    pass

我用drf_yasg 作为招摇。

我做了上面的编码并用swagger测试了它，当我用Chrome检查时，请求有效载荷是x = 124 & y = 124124。

并且，出现以下消息，发生了错误的请求错误。

{
  "detail": "JSON parse error - Expecting value: line 1 column 1 (char 0)"
}

swagger中加post参数有错吗？

Answer 1

问题是您将form 类型的参数添加到swagger，但您的视图似乎期望请求正文中有一个json 有效负载。在这种情况下，您可能希望将request_body 与openapi.Schema 对象一起使用。

@swagger_auto_schema(method='post', request_body=openapi.Schema(
    type=openapi.TYPE_OBJECT, 
    properties={
        'x': openapi.Schema(type=openapi.TYPE_STRING, description='string'),
        'y': openapi.Schema(type=openapi.TYPE_STRING, description='string'),
    }
))
@api_view(['POST'])
def test(request):
    pass

这会自动将您的Schema 包装成Parameter 或in_=openapi.IN_BODY。 详情请见https://drf-yasg.readthedocs.io/en/stable/openapi.html。

当然，首选的方法是使用基于类的GenericAPIView 和Serializer，这样可以简化视图代码和文档内省。