问题描述
我有一个简单的 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 (将#修改为@)