使用 drf-spectacular 和 x-www-form-urlencoded 请求的 Swagger UI 示例

Question

是否可以生成一个包含application/json和x-www-form-urlencoded请求体示例的招摇过市UI页面（以及redoc）？我可以得到application/json的示例，但在swagger/redoc UI中选择x-www-form-urlencoded作为请求类型时却没有。

我将以下装饰器用于“create”方法（在ModelViewSet中）

@extend_schema(request=MySerializer)

其中 MySerializer 如下所示...

@extend_schema_serializer(
    examples=[
        OpenApiExample(
            'Example input',
            description='Creation of an alias',
            value={
                'user_id': 1234567890,
                'obj_id': 288,
                'alias': 'my alias'
            },
            request_only=True,
            response_only=False,
        ),
    ],
)
class MySerializer(serializers.Serializer):
    user_id = serializers.IntegerField()
    obj_id = serializers.IntegerField()
    alias = serializers.CharField(max_length=50)

swagger/redocs ui将很乐意为应用程序/json请求体提供一个带有“示例输入”的示例下拉框(选择示例将填充json)，但对于x-www-form-urlencoded，将只显示一个要填写的表单，没有示例下拉框来填充字段。

我可以获取查询字符串的示例（及其选择下拉框），即在制作使用OpenApiParameter的GETendpoint时，例如。

@extend_schema(
        parameters=[
            OpenApiParameter(name='q', description='Query string to search for', required=True, type=str,
                examples=[
                    OpenApiExample(
                        'Search query',
                        value='foobar'
                    ),
                ]
            ),
            ...
        ]
    )

其中，选择放置框条目将填充文本字段。

但是，对于x-www-form-urlencoded，这似乎没有生成？

这可能吗？我做错什么了吗？

Answer 1

对于示例数据，Redoc非常手工，因为很少基于模式自动生成示例。

AFAIK SwaggerUI确实从模式生成了一个基本示例，但也仅适用于JSON。

如果您想要< code > application/x-www-form-urlencoded 示例，您可能需要手动指定每个示例。不确定果汁是否值得挤在那里。

现在来看看 drf-spectacular：OpenApiExample 是默认的 JSON，所以如果你想要一个不同的编码，你需要显式设置它，并提供一个正确编码的值字符串：

        OpenApiExample(
            'Form-encoded example 1',
            value='YOUR HANDMADE FROM ENCODED DATA STRING',
            media_type='application/x-www-form-urlencoded'
        )