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

Question

I am using Django Rest Swagger to document my API which is made with Django Rest Framework . My APIClass has two methods: get and post. And I want the documentation to note this difference but it seems that it expect both to have the same params . Look:

This is generating documentation well :

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

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

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

But what I want is this , which is not generating documentation well:

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
       """
       ...

How can I do it? Any idea?? Thanks so much! ;-)

Answer 1

Josep your updated method documentation is correct. The issue you report is well-known in the django-rest-swagger community. See this commit for the fix. Unfortunately Mr. Gibbons has not merged this fix into master, but you can certainly fork and patch as many other people have done.