drf_yasg 不将 TYPE_ARRAY 作为有效类型

anu*_*ysh 2 swagger django-rest-framework drf-yasg

drf_yasg swagger 生成器不将 TYPE_ARRAY 作为有效参数类型。实现如下

from drf_yasg import openapi
param1 = openapi.Parameter('param_name',
                            in_=openapi.IN_QUERY,
                            description='description of param',
                            type=openapi.TYPE_ARRAY,
                            required=True
                            )
Run Code Online (Sandbox Code Playgroud)

而drf_yasg的文档表明它将 openapi.TYPE_ARRAY 作为有效类型。

生成器抛出的错误是

File "/usr/local/lib/python3.6/dist-packages/drf_yasg/codecs.py", line 73, in encode
    raise SwaggerValidationError("spec validation failed", errors, spec, self)
drf_yasg.errors.SwaggerValidationError: spec validation failed
Run Code Online (Sandbox Code Playgroud)

是否有一些我遗漏的配置或其他原因,因为 TYPE_STRING,TYPE_NUMBER 工作得很好。

axn*_*san 9

A ParameterofTYPE_ARRAY需要items密钥:

param1 = openapi.Parameter('param_name',
                            in_=openapi.IN_QUERY,
                            description='description of param',
                            type=openapi.TYPE_ARRAY,
                            items=openapi.Items(type=openapi.TYPE_STRING)  # <------
                            required=True
)
Run Code Online (Sandbox Code Playgroud)

有关更多详细信息,请参阅OpenAPI 2.0 规范