web-dev-qa-db-ja.com

Django APIを残し、ドキュメントを自動化しますか？

ビューセットを作成して Django rest docs を使用しながら、APIのドキュメント化を試みました。次の問題があります。

  • 逆関連フィールドの値を送信しようとすると、値のリストが取得されますが、データをフォームデータで送信すると、文字列として送信されます。

  • ドキュメントUIにファイルをアップロードするオプションはありません。

以下は私のコードです：

models.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')

view.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})

serializer.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/ を使用しています

デフォルトのドキュメントの画像フィールドにはファイルのアップロードはありません。

enter image description here

ありがとう

pythondjangodjango-rest-frameworkapi-docdjango-swagger
23
Ravi Bhushan

別の良いアイデアは Swagger を使用することです。 Djangoでは、特にDRFを使用して、 Django Rest Swagger と統合し、エンドポイントの自動ドキュメントを生成する機会があります。唯一の要件は、docstrings-documentationでAPIクラスとメソッドを提供することです。

pS：私はDjango Rest Swaggerパッケージまたは作者とは関係ありません、頻繁に使用するユーザーのみです。

1
Kostas Livieratos