drf_yasg定制

最新推荐文章于 2024-08-12 08:59:34 发布

程序猿_小天

最新推荐文章于 2024-08-12 08:59:34 发布

阅读量1.2k

点赞数

分类专栏： Django 文章标签： drf drf_yasg swagger 接口

本文链接：https://blog.csdn.net/u011798443/article/details/119645721

版权

Django 专栏收录该内容

28 篇文章 3 订阅

订阅专栏

在写DRF接口的时候,如果我们使用的ModelViewset,这个时候生成的swagger接口文档中,参数和响应都是没有问题的。但是有些接口，我们需要定制，这时候的接口文档显得不那么友好。

栗子.py

from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema

class StorageViewSet(APIView):
 	#定义warehouseId字字段
 	# required -> 是否必填
 	# in_  -> 应用为 query
 	#description -> 描述
 	#type -> 字符串
    warehouseId = openapi.Parameter('warehouseId', required=True,in_=openapi.IN_QUERY, description='仓库Id',
                                    type=openapi.TYPE_STRING)
   	#装饰器：
   	# manual_parameters ->查询使用的字段
   	#responses -> 响应结果
   	# operation_id  ->随便填写，但是要唯一
   	# operation_description ->接口说明
    @swagger_auto_schema(
        manual_parameters=[warehouseId],
        responses={
            '200': openapi.Response('', GetStorageSerializer)
        },
        security=[],
        operation_id='StorageViewSet-get',
        operation_description='获取库存信息',
    )
    def get(self,request):
        params = request.query_params
        warehouseId = params.get('warehouseId')
        warehouseId = Warehouse.objects.filter(id=warehouseId).first()
        queryset = Storage.objects.filter(warehouseId=warehouseId).values('system', 'classify')\
            .annotate(warehouseNumber=Sum('warehouseNumber'),
                      palautusNumber=Sum('palautusNumber'), )
        serializer = GetStorageSerializer(queryset,many=True)
        return SuccessResponse(data=serializer.data,  msg="操作成功")