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

时间:2015-04-27 16:24:46

标签: python django django-rest-framework documentation-generation

我正在使用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()

在生成的文档中,页面参数部分中的嵌套序列化程序使用 field 数据类型呈现,并且没有给出有关其内容的提示,它们就像其他领域。

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

理想情况是在数据类型列中有模型描述,就像响应类 section一样。

有没有正确的方法呢?

1 个答案:

答案 0 :(得分:0)

1。,请使用drf-yasg作为文档。

2。。您可以在我的一个存储库Kirpi中找到其实现,并了解如何使用它。

3。(如果您在 3。中);有问题,让我知道。