Swagger UI

Author: soufianechalouh

Diff for: django_drf_auth_plus/authentication/serializers.py

@@ -18,3 +18,11 @@ def validate(self, attrs):
 
     def create(self, validated_data):
         return User.object.create_user(**validated_data)
+
+
+class EmailValidationSerializer(serializers.ModelSerializer):
+    token = serializers.CharField(max_length=555)
+
+    class Meta:
+        model = User
+        fields = ["token"]

Diff for: django_drf_auth_plus/authentication/views.py

@@ -1,14 +1,16 @@
 from rest_framework.generics import GenericAPIView
 from rest_framework.response import Response
-from rest_framework import status
-from .serializers import RegisterSerializer
+from rest_framework import status, views
+from .serializers import RegisterSerializer, EmailValidationSerializer
 from rest_framework_simplejwt.tokens import RefreshToken
 from .models import User
 from .utils import Util
 from django.contrib.sites.shortcuts import get_current_site
 from django.urls import reverse
 import jwt
 from django.conf import settings
+from drf_yasg.utils import swagger_auto_schema
+from drf_yasg import openapi
 
 
 class RegisterView(GenericAPIView):
@@ -34,8 +36,11 @@ def post(self, request):
         return Response(user_data, status=status.HTTP_201_CREATED)
 
 
-class VerifyEmail(GenericAPIView):
+class VerifyEmail(views.APIView):
+    serializer_class = EmailValidationSerializer
+    token_param_config = openapi.Parameter("token", in_=openapi.IN_QUERY, description="Desc", type=openapi.TYPE_STRING)
 
+    @swagger_auto_schema(manual_parameters=[token_param_config])
     def get(self, request):
         token = request.GET.get("token")
 

Diff for: django_drf_auth_plus/django_drf_auth_plus/settings.py

@@ -39,6 +39,7 @@
     'django.contrib.staticfiles',
     'rest_framework',
     'authentication',
+    'drf_yasg',
 ]
 
 REST_FRAMEWORK = {

Diff for: django_drf_auth_plus/django_drf_auth_plus/urls.py

@@ -16,8 +16,27 @@
 from django.contrib import admin
 from django.urls import path, include
 from rest_framework_simplejwt.views import TokenObtainPairView, TokenRefreshView
+from rest_framework import permissions
+from drf_yasg.views import get_schema_view
+from drf_yasg import openapi
+
+
+schema_view = get_schema_view(
+   openapi.Info(
+      title="Authentication API",
+      default_version='v1',
+      description="Test description",
+      terms_of_service="https://www.google.com/policies/terms/",
+      contact=openapi.Contact(email="[email protected]"),
+      license=openapi.License(name="BSD License"),
+   ),
+   public=True,
+   permission_classes=(permissions.AllowAny,),
+)
 
 urlpatterns = [
+    path('', schema_view.with_ui('swagger', cache_timeout=0), name='schema-swagger-ui'),
+    path('redoc/', schema_view.with_ui('redoc', cache_timeout=0), name='schema-redoc'),
     path('admin/', admin.site.urls),
     path("auth/", include("authentication.urls")),
     path('api/token/', TokenObtainPairView.as_view(), name='token_obtain_pair'),

Diff for: requirements.txt

@@ -1,7 +1,25 @@
 asgiref==3.3.4
+certifi==2020.12.5
+chardet==4.0.0
+coreapi==2.3.3
+coreschema==0.0.4
 Django==3.2
 djangorestframework==3.12.4
 djangorestframework-simplejwt==4.6.0
+drf-yasg==1.20.0
+future==0.18.2
+idna==2.10
+inflection==0.5.1
+itypes==1.2.0
+Jinja2==2.11.3
+MarkupSafe==1.1.1
+packaging==20.9
 PyJWT==1.7.1
+pyparsing==2.4.7
 pytz==2021.1
+requests==2.25.1
+ruamel.yaml==0.17.4
+ruamel.yaml.clib==0.2.2
 sqlparse==0.4.1
+uritemplate==3.0.1
+urllib3==1.26.4