ViewSet. Как прописать docstring для каждой функции ViewSet?

Question

[exctac]

Всем привет!
Пример использования ViewSet

Но мне не понятно, как для каждого из методов обработки запроса прописать отдельный docstring, если параметр description всего один и распространяется на весь ViewSet?

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
    'post': 'create'
}, description="description")

Если взять стандартный например дженерик ListAPIView, то переопределив метод get есть возможность прописать свой docstring. И в swagger для метода get выводится это описание.

Answer 1

[Сергей Тихонов]

Если переопределить в SnippetViewSet метод list, описав у него docstring - его подхватит swagger.

Comments

[exctac]

Увы, уже пробовал.

def list(self, request, *args, **kwargs):
        """SnippetViewSet метод list"""
        return super(SnippetViewSet, self).list(request, *args, **kwargs)

причем если так делать, то в свагере затирается основное описание

[Сергей Тихонов]

Вот именно так оно и работает, если сваггер подключать через drf_yasg. А вы чем подключаете?

[exctac]

Сергей Тихонов, у меня не drf_yasg

from rest_framework_swagger.views import get_swagger_view

schema_view = get_swagger_view(title='API')
urlpatterns += [
 path('docs/swagger/', schema_view),
]

[Сергей Тихонов]

Django REST Swagger: deprecated (2019-06-04)
This project is no longer being maintained. Please consider drf-yasg as an alternative/successor. I haven't personally used it, but it looks feature-complete and is actively maintained.

С главной страницы библиотеки на гитхабе.

[exctac]

Сергей Тихонов, ок спасибо за наводку!

Answer 2

[exctac]

Возможность есть, но какая то она кривая :

snippet_list = SnippetViewSet.as_view({
    'get': 'list',
}, description="snippet_list")
snippet_create = SnippetViewSet.as_view({
   'post': 'create'
}, description="snippet_create")