API文档 - Django Rest Swagger - 用于GET和POST的不同参数

Question

我正在使用 Django Rest Swagger 来记录我的API，该API是用 Django Rest Framework 制作的。 我的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):
       ...

但我想要的是这个，不很好地生成文档：

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社区中是众所周知的。有关此修复程序，请参阅this commit。不幸的是Gibbons先生还没有将这个修复程序合并到master中，但是你可以像许多其他人一样分叉和修补。