私はビューセットを書いて使用しながらAPIを文書化しようとしましたDjango REST ドキュメント次のような問題が発生しています:
逆関連フィールドの値を送信しようとすると、値のリストが取得されますが、フォームデータでデータを送信すると、文字列として送信されます。
ドキュメント UI にはファイルのアップロードオプションがありません。
以下は私のコードです:
モデル.py
class Area(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
name = models.CharField(max_length=100)
address = models.TextField()
image = models.ImageField(upload_to='area/')
created_on = models.DateTimeField(auto_now_add=True)
modified_on = models.DateTimeField(auto_now=True)
zipcode = models.CharField(max_length=15, null=True)
is_verified = models.BooleanField(default=False)
class Meta:
ordering = ('-modified_on',)
class Email(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
email = models.EmailField()
area = models.ForeignKey(Area, on_delete=models.CASCADE, null=True, related_name='email')
class Phone(models.Model):
id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
phone = models.CharField(max_length=15)
area = models.ForeignKey(Area, on_delete=models.CASCADE, null=True, related_name='phone')
ビュー.py
class AreaViewSet(viewsets.ModelViewSet):
"""
create:
Create a new area instance.
"""
serializer_class = AreaSerializer
parser_classes = (FormParser, MultiPartParser,FileUploadParser)
queryset = User.objects.all()
permission_classes = [AllowAny, ]
filter_backends = (DjangoFilterBackend,)
filter_fields = ('first_name',)
def create(self, request):
data = self.request.data
with transaction.atomic():
name = data['name']
address = data['address']
email = json.loads(data['email'])
phone = json.loads(data['phone'])
zipcode = data['zipcode']
area = Area.objects.create(name=name,address=address, zipcode=zipcode)
for i in email:
Email.objects.create(email=i['email'], area = area)
for i in phone:
Phone.objects.create(phone=i['phone'], area=area)
return Response({'status': {'code': status.HTTP_200_OK,
'error': None,
'message':' Area has been added.'
},
'data': None})
シリアライザ.py
class AreaSerializer(serializers.ModelSerializer):
email = EmailSerializer(many=True)
phone = PhoneSerializer(many=True)
class Meta:
model = Area
fields = '__all__'
使っていますhttp://www.django-rest-framework.org/topics/documenting-your-api/
デフォルトのドキュメントでは、画像フィールドにファイルのアップロードはありません。
ありがとう
ベストアンサー1
もう一つの良いアイデアは、威勢のいいDjangoでは、特にDRFを使用すると、Django レスト スワッガーエンドポイントのドキュメントを自動的に生成します。必要なのは、API クラスとメソッドに docstrings-documentation を提供することだけです。
追伸：私はDjango REST Swaggerパッケージやその作者とは何の関係もありません。ただの常連ユーザーです。