1

我正在使用 drf_yasg 对我的 API 进行自我记录，该 API 是使用 django-framework 构建的，但是对于任何端点都没有显示任何参数。我这样做的方式是以 JSON 格式在 http 请求正文中传递参数。然后我从 request.data 中读取参数。下面是其中一个视图的示例，其中将“id”作为请求正文中的参数。

@api_view(['POST'])
@permission_classes([IsAuthenticated])
def get_availability_by_schoolid(request):
    if request.user.is_donor:
        try:
            #Get the existing slots and remove them to replace with new slots
            slots = SchoolSlot.objects.filter(school__id=request.data["id"]).values('day','am','pm')
            availability = process_availability(slots)
            availabilityslotserializer = SchoolSlotSerializer(availability)
            return Response(availabilityslotserializer.data, status=status.HTTP_200_OK)
        except Exception as e:
            print(e)
            return Response(ResponseSerializer(GeneralResponse(False,"Unable to locate school")).data, status=status.HTTP_400_BAD_REQUEST)
    else:
        return Response(ResponseSerializer(GeneralResponse(False,"Not registered as a donor")).data, status=status.HTTP_400_BAD_REQUEST)

这将显示在 swagger 文档中，如下所示：

大摇大摆的输出

我一直在查看文档，它建议我可能需要添加带有手动参数的装饰器，但我无法弄清楚我会如何做到这一点，因为我可以找到的示例是获取查询参数或路径参数。我在下面添加了装饰器，它可以响应文档。

@swagger_auto_schema(method='post', responses={200: SchoolSlotSerializer,400: 'Bad Request'})

请求正文的一个示例是：

  { "id": 43 }

更新：

我似乎得到了以下装饰器的东西：

@swagger_auto_schema(method='post', request_body=openapi.Schema(
    type=openapi.TYPE_OBJECT,
    properties={
        'id': openapi.Schema(type=openapi.TYPE_INTEGER, description='Donor ID')
    }),
    responses={200: SchoolSlotSerializer,400: 'Bad Request'})

这记录了参数。现在我为另一个端点所拥有的是它需要以下 JSON 作为输入，我将如何添加它？

  {
        "availability": {
            "mon": {
                "AM": true,
                "PM": false
            },
            "tue": {
                "AM": false,
                "PM": false
            },
            "wed": {
                "AM": false,
                "PM": false
            },
            "thu": {
                "AM": true,
                "PM": true
            },
            "fri": {
                "AM": false,
                "PM": false
            },
            "sat": {
                "AM": false,
                "PM": false
            },
            "sun": {
                "AM": true,
                "PM": false
            }
    }
    }
4

2 回答 2

3

您可以为此使用 ModelSerializer：

@swagger_auto_schema(method='post', request_body=ModelSerializer)
于 2020-11-28T15:32:50.223 回答
0

我相信这是使它能够工作的原因：

如果有更好的方法，请告诉我。

@swagger_auto_schema(method='post', request_body=openapi.Schema(
    type=openapi.TYPE_OBJECT,
    properties={
        'id': openapi.Schema(type=openapi.TYPE_INTEGER, description='Donor ID')
    }),
    responses={200: SchoolSlotSerializer,400: 'Bad Request'})
于 2020-12-07T07:18:25.050 回答