微信公众号搜"智元新知"关注
微信扫一扫可直接关注哦!

有没有办法在 DRF 中的 swagger/redoc 文档中描述多个主体?

如何解决有没有办法在 DRF 中的 swagger/redoc 文档中描述多个主体?

我有一个简单的 django-rest-framework 应用程序,我需要在 swagger(或其他)api 文档工具中描述我的 API。我有一个简单的看法:

class AnimalViewSet(viewsets.ViewSet):
    def create(self,request):
        serializer = CreateAnimalRequestSerializer(data=request.data)
        # some logic
        return Response(serializer.data)

序列化器看起来像这样:

class CreateAnimalRequestSerializer(Serializer):
     type = ChoiceField(choices=ANIMAL_CHOICES)
     body = serializers.SerializerMethodField()
     description = CharField(max_length=20)

     def get_body(self,animal):
        if animal.type == "CAT":
            return CatSerializer(animal.body)
        elif animal.modelName == "DOG":
            return DogSerializer(animal.body)

请注意,body 字段取决于动物的类型。

但是任何 api 文档工具都会像这样生成我的请求示例:

{
  "type": "CAT","body": {},# Now it is a dictionary without description. But i want choose body depending on the type
  "description": "string"
}

有没有办法根据类型选择字段的正文? 或者api文档工具允许继承吗? 也就是说,我的问题是:是否可以在 swagger(或其他 api 文档工具)中为一个端点描述多个请求主体?

版权声明:本文内容由互联网用户自发贡献,该文观点与技术仅代表作者本人。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如发现本站有涉嫌侵权/违法违规的内容, 请发送邮件至 dio@foxmail.com 举报,一经查实,本站将立刻删除。