Add swagger_auto_schema method decorator for Operation customization
See #5.
This commit is contained in:
@@ -9,6 +9,7 @@ from rest_framework.response import Response
|
||||
|
||||
from articles import serializers
|
||||
from articles.models import Article
|
||||
from drf_swagger.utils import swagger_auto_schema
|
||||
|
||||
|
||||
class ArticleViewSet(viewsets.ModelViewSet):
|
||||
@@ -20,6 +21,9 @@ class ArticleViewSet(viewsets.ModelViewSet):
|
||||
|
||||
destroy:
|
||||
destroy class docstring
|
||||
|
||||
partial_update:
|
||||
partial_update class docstring
|
||||
"""
|
||||
queryset = Article.objects.all()
|
||||
lookup_field = 'slug'
|
||||
@@ -40,11 +44,9 @@ class ArticleViewSet(viewsets.ModelViewSet):
|
||||
serializer = self.serializer_class(articles, many=True)
|
||||
return Response(serializer.data)
|
||||
|
||||
@detail_route(
|
||||
methods=['get', 'post'],
|
||||
parser_classes=(MultiPartParser,),
|
||||
serializer_class=serializers.ImageUploadSerializer,
|
||||
)
|
||||
@swagger_auto_schema(method='get', operation_description="image GET description override")
|
||||
@swagger_auto_schema(method='post', request_body=serializers.ImageUploadSerializer)
|
||||
@detail_route(methods=['get', 'post'], parser_classes=(MultiPartParser,))
|
||||
def image(self, request, slug=None):
|
||||
"""
|
||||
image method docstring
|
||||
@@ -55,6 +57,11 @@ class ArticleViewSet(viewsets.ModelViewSet):
|
||||
"""update method docstring"""
|
||||
return super(ArticleViewSet, self).update(request, *args, **kwargs)
|
||||
|
||||
@swagger_auto_schema(operation_description="partial_update description override")
|
||||
def partial_update(self, request, *args, **kwargs):
|
||||
"""partial_update method docstring"""
|
||||
return super(ArticleViewSet, self).partial_update(request, *args, **kwargs)
|
||||
|
||||
def destroy(self, request, *args, **kwargs):
|
||||
"""destroy method docstring"""
|
||||
return super(ArticleViewSet, self).destroy(request, *args, **kwargs)
|
||||
|
||||
+15
-1
@@ -1,9 +1,12 @@
|
||||
from django.contrib.auth.models import User
|
||||
from rest_framework import status
|
||||
from rest_framework.decorators import api_view
|
||||
from rest_framework.generics import get_object_or_404
|
||||
from rest_framework.response import Response
|
||||
from rest_framework.views import APIView
|
||||
|
||||
from drf_swagger import openapi
|
||||
from drf_swagger.utils import swagger_auto_schema
|
||||
from users.serializers import UserSerializer
|
||||
|
||||
|
||||
@@ -15,8 +18,19 @@ class UserList(APIView):
|
||||
serializer = UserSerializer(queryset, many=True)
|
||||
return Response(serializer.data)
|
||||
|
||||
@swagger_auto_schema(request_body=UserSerializer, operation_description="apiview post description override")
|
||||
def post(self, request):
|
||||
serializer = UserSerializer(request.data)
|
||||
serializer.is_valid(raise_exception=True)
|
||||
serializer.save()
|
||||
return Response(serializer.data, status=status.HTTP_201_CREATED)
|
||||
|
||||
@api_view(['GET'])
|
||||
|
||||
@swagger_auto_schema(method='put', request_body=UserSerializer)
|
||||
@swagger_auto_schema(method='get', manual_parameters=[
|
||||
openapi.Parameter('test', openapi.IN_QUERY, "test manual param", type=openapi.TYPE_BOOLEAN)
|
||||
])
|
||||
@api_view(['GET', 'PUT'])
|
||||
def user_detail(request, pk):
|
||||
"""user_detail fbv docstring"""
|
||||
user = get_object_or_404(User.objects, pk=pk)
|
||||
|
||||
Reference in New Issue
Block a user