API文檔-Django Rest Swagger-GET和POST的不同參數

Question

我正在使用Django Rest Swagger來記錄由Django Rest Framework制作的API。 我的APIClass有兩種方法：get和post。 我希望文檔注意這種差異，但似乎希望兩者具有相同的參數 。 看：

這很好地生成了文檔：

class Product(APIView):
    """
    Do something with product
    param1 -- Product name
    param2 -- Category
    """

    def get(self, request, format=None):
       ...

    def post(self, request, format=None):
       ...

但是我想要的是this ，它不能很好地生成文檔：

class Product(APIView):

    def get(self, request, format=None):
       """
       Get products
       param1 -- Parameter for filtering by category
       """
       ...

    def post(self, request, format=None):

       """
       Create a new product
       param1 -- Product name
       param2 -- Category
       """
       ...

我該怎么做？ 任何想法？？ 非常感謝！ ;-)

Answer 1

Josep您更新的方法文檔是正確的。 您報告的問題在django-rest-swagger社區中眾所周知。 有關修復，請參見此提交 。 不幸的是，Gibbons先生沒有將此修補程序合並到master中，但是您可以像其他許多人一樣進行分叉和修補。