Django、apidoc js PUTメソッドに何を追加しますか？

Question

私はapidoc.jsのドキュメントを読みましたが、私はジレンマがあります。 @apiParamと@apiSuccesの違いを正確には知りません。ドキュメンテーションは実際に何を正しく説明していません。例えば、私が手やGETでこれらのパラメータを持つ入れている：

を私はジャンゴで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) 

私はプットapidocを作成したいです。私はそれを修正するために何を書かなければならないのですか？私は再びすべてのパラメータを記述する必要がありますか？またはapiSuccessを使用しますか？例が素晴らしいだろう。

@apiSuccess：@apiSuccessと@apiParamの違いがあることである

Answer 1

まあ、正常な応答のためのフィールドとそのデータ型について説明します。

@apiParam：パス入力パラメータのフィールドとそのデータ型を記述します。

より正確には、あなたが応答が（成功応答）どのように見えるかを記述するためにapiSuccessを使用して、あなたはその応答に対する要求が

を含まなければならないかを説明するためにapiParamを使用して、私はthis blogが提供見つけますapidocの使い方の良い例です。あなたはちょうどあなたのdjangoアプリケーションにそれを適応させる必要があります