javascript - Django、apidoc js 在 PUT 方法中添加什么？

Question

我已阅读 apidoc.js 文档，但我遇到了困境。我不太清楚 @apiParam 和 @apiSucces 之间的区别，文档没有正确解释它们的真正作用。例如，我有一个 get 和一个 put，其中包含这些参数:

我在 django 中使用 apidoc，这是我的观点:

class LocationView(APIView):

    """
    @api {get} /locations/:id/ Location id - details
    @apiName GetLocation
    @apiGroup Locations

    @apiParam {integer} [id] Location id.
    @apiParam {string} [name] Location name.
    @apiParam {object} [company] Company name.
    @apiParam {string} [website] Location website.

    @apiSuccess {object[]} results List with location details
    """
    serializer_class = LocationSerializer
    permission_classes = (IsAuthenticatedOrReadOnly,)

    def get_object(self, pk):
        try:
            return Location.objects.get(pk=pk)
        except Location.DoesNotExist:
            raise Http404

    def get(self, request, pk):
        serializer = LocationSerializer(self.get_object(pk))
        return Response(serializer.data)

    def put(self, request, pk):
        location = self.get_object(pk)
        serializer = LocationSerializer(location, data=request.data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data)
        return Response(serializer.errors, status=status.HTTP_400_BAD_REQUEST)

    def delete(self, request, pk):
        location = self.get_object(pk)
        location.save()
        return Response(status=status.HTTP_204_NO_CONTENT)

我想创建 put apidoc。我需要在里面写什么来修改？我需要重新编写每个参数吗？或者使用apiSuccess？举个例子就太好了。

Answer 1

嗯，@apiSuccess 和 @apiParam 之间的区别是:

@apiSuccess:描述成功响应的字段及其数据类型；

@apiParam:描述路径输入参数的字段及其数据类型；

更准确地说，您使用 apiSuccess 来描述响应的外观(成功响应)，并使用 apiParam描述该响应的请求应包含的内容

我找到this blog提供了如何使用 apidoc 的一个很好的示例。您只需将其适应您的 django 应用程序即可