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中，但是您可以像其他许多人一样进行分叉和修补。