django-rest-swagger嵌套的序列化程序,其readonly字段未正确呈现

Question

我正在用django-rest-framework构建一个API,我开始使用django-rest-swagger来编写文档.我有一个嵌套的序列化程序,其中包含一些read_only字段,如下所示:

# this is the nested serializer
class Nested(serializers.Serializer):
    normal_field = serializers.CharField(help_text="normal")
    readonly_field = serializers.CharField(read_only=True,
                                           help_text="readonly")

# this is the parent one
class Parent(serializers.Serializer):
    nested_field = Nested()

在生成的文档中,页面的Parameters部分中的嵌套序列化器使用字段数据类型呈现,并且没有给出有关其内容的提示,它们就像其他字段一样.

现在你可以在那里看到问题,因为我想通知用户有一个readonly字段不应该作为嵌套数据的一部分发送,但我看不到这样做的方法.

理想的是在"数据类型"列中具有模型描述,就像" 响应类" 部分一样.

有没有正确的方法呢？

Answer 1

1.所有内容请使用drf-yasg来获取文档。

2.您可以在我的存储库Kirpi之一中找到它的实现并学习如何使用它。

3.如果你在3 .；有问题请告诉我。