DRF-YASG：为GET请求文档编写输入和输出序列化器

Question

我愿意用drf-yasg记录GET请求的输入模式和输出模式，但似乎并不容易。

     @swagger_auto_schema(
         manual_parameters=[
             openapi.Parameter('cart_id', in_=openapi.IN_QUERY,
                               type=openapi.TYPE_INTEGER)
         ])

上面的代码显示了GET参数，但不知何故隐藏了响应模式。

@swagger_auto_schema(methods=['put', 'post'], request_body=UserSerializer)

我无法将 request_body 用于 GET 查询参数，它只能用于 POST 请求体

那么我该如何使用 drf-yasg 来记录我的输入模式和输出模式？

- eugene

Answer 1

你可以使用 query_serializer。

发现它在官方文档中很难找到。你可以参考这篇文章：https://medium.com/@arjunsinghy96/customised-api-documentation-for-django-rest-framework-projects-using-drf-yasg-d6db9ba5cff3。

该文章介绍了如何使用DRF-YASG为Django REST Framework项目定制API文档。

- eugene

Answer 2

我的 API 视图是：

    class ProductListView(APIView):
        """
            get 1 or list of products for show to users
        """
    
        serializer_class = ProductGetSerializer
        permission_classes = (
            AllowAny,
        )
    
        def get(self, request, product_id=None):
            if product_id is not None:
                product = get_object_or_404(Product.confirmed, pk=product_id)
                srz_data = self.serializer_class(instance=product)
                return Response(data=srz_data.data, status=status.HTTP_200_OK)
    
            products = Product.confirmed.all()
            srz_data = self.serializer_class(instance=products, many=True)
            return Response(data=srz_data.data, status=status.HTTP_200_OK)

我的序列化器也是ModelSerializer：

class ProductGetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Product
        fields = (
            'id',
            'name',
            'image',
            'category',
            'description',
            'price',
            'stock',
        )

请勿在 drf_yasg 中仅限于 GET 视图中为我显示参数。

- Ali Rahmani

---

这不是一个答案。 - Elias Prado