fureunoir/schon
fureunoir/schon
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Features: 1) Add schema documentation using extend_schema_view decorators for TokenObtainPairView, TokenRefreshView, and TokenVerifyView.

Browse source 
Fixes: 1) Remove unused imports for serializers and inline_serializer from drf_spectacular.utils.

Extra: Refactor and simplify code by replacing inline schema definitions with centralized schema references (TOKEN_OBTAIN_SCHEMA, TOKEN_REFRESH_SCHEMA, TOKEN_VERIFY_SCHEMA) and removing redundant response examples.
This commit is contained in:
Egor Pavlovich Gorbunov 2025-05-13 23:13:09 +03:00
parent 7040c97791
commit 8f46c19b53
1 changed files with 6 additions and 119 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

125
vibes_auth/views.py
View file

@ -4,161 +4,48 @@ from django.utils.decorators import method_decorator
from django.utils.translation import gettext_lazy as _ from django.utils.translation import gettext_lazy as _
from django_ratelimit.decorators import ratelimit from django_ratelimit.decorators import ratelimit
from drf_spectacular.utils import ( from drf_spectacular.utils import (
OpenApiExample, extend_schema_view,
OpenApiResponse,
extend_schema,
inline_serializer,
) )
from rest_framework import serializers, status from rest_framework import status
from rest_framework.response import Response from rest_framework.response import Response
from rest_framework_simplejwt.exceptions import TokenError from rest_framework_simplejwt.exceptions import TokenError
from rest_framework_simplejwt.views import TokenViewBase from rest_framework_simplejwt.views import TokenViewBase
from vibes_auth.docs.drf.views import TOKEN_OBTAIN_SCHEMA, TOKEN_REFRESH_SCHEMA, TOKEN_VERIFY_SCHEMA
from vibes_auth.serializers import ( from vibes_auth.serializers import (
TokenObtainPairSerializer, TokenObtainPairSerializer,
TokenRefreshSerializer, TokenRefreshSerializer,
TokenVerifySerializer, TokenVerifySerializer,
UserSerializer,
) )
logger = logging.getLogger(__name__) logger = logging.getLogger(__name__)
@extend_schema_view(**TOKEN_OBTAIN_SCHEMA)
class TokenObtainPairView(TokenViewBase): class TokenObtainPairView(TokenViewBase):
serializer_class = TokenObtainPairSerializer serializer_class = TokenObtainPairSerializer
_serializer_class = TokenObtainPairSerializer _serializer_class = TokenObtainPairSerializer
@extend_schema(
description="Obtain a token pair (refresh and access) for authentication.",
responses={
200: inline_serializer(
name="TokenObtain",
fields={
"refresh": serializers.CharField(),
"access": serializers.CharField(),
"user": UserSerializer(),
},
),
400: OpenApiResponse(
description="Bad Request",
examples=[
OpenApiExample(
name="InvalidCredentials",
description="Example of an invalid credentials error",
value={
"code": 1001,
"message": "Invalid credentials were provided.",
},
response_only=True,
)
],
),
401: OpenApiResponse(
description="Unauthorized",
examples=[
OpenApiExample(
name="TokenExpired",
description="Example of an expired token error",
value={"code": 1002, "message": "Token is invalid or expired."},
response_only=True,
)
],
),
},
)
@method_decorator(ratelimit(key="ip", rate="5/h")) @method_decorator(ratelimit(key="ip", rate="5/h"))
def post(self, request, *args, **kwargs): def post(self, request, *args, **kwargs):
return super().post(request, *args, **kwargs) return super().post(request, *args, **kwargs)
@extend_schema_view(**TOKEN_REFRESH_SCHEMA)
class TokenRefreshView(TokenViewBase): class TokenRefreshView(TokenViewBase):
serializer_class = TokenRefreshSerializer serializer_class = TokenRefreshSerializer
_serializer_class = TokenRefreshSerializer _serializer_class = TokenRefreshSerializer
@extend_schema(
description="Refresh a token pair (refresh and access).",
responses={
200: inline_serializer(
name="TokenRefreshResponse",
fields={
"refresh": serializers.CharField(),
"access": serializers.CharField(),
"user": UserSerializer(),
},
),
400: OpenApiResponse(
description="Bad Request",
examples=[
OpenApiExample(
name="InvalidCredentials",
description="Example of an invalid credentials error",
value={
"code": 1001,
"message": "Invalid credentials were provided.",
},
response_only=True,
)
],
),
401: OpenApiResponse(
description="Unauthorized",
examples=[
OpenApiExample(
name="TokenExpired",
description="Example of an expired token error",
value={"code": 1002, "message": "Token is invalid or expired."},
response_only=True,
)
],
),
},
)
@method_decorator(ratelimit(key="ip", rate="5/h")) @method_decorator(ratelimit(key="ip", rate="5/h"))
def post(self, request, *args, **kwargs): def post(self, request, *args, **kwargs):
return super().post(request, *args, **kwargs) return super().post(request, *args, **kwargs)
@extend_schema_view(**TOKEN_VERIFY_SCHEMA)
class TokenVerifyView(TokenViewBase): class TokenVerifyView(TokenViewBase):
serializer_class = TokenVerifySerializer serializer_class = TokenVerifySerializer
_serializer_class = TokenVerifySerializer _serializer_class = TokenVerifySerializer
@extend_schema(
description="Verify a token (refresh or access).",
responses={
200: inline_serializer(
name="TokenVerifyResponse",
fields={
"token": serializers.CharField(choices=["valid", "no valid"]),
"user": UserSerializer(),
},
),
400: OpenApiResponse(
description="Bad Request",
examples=[
OpenApiExample(
name="InvalidCredentials",
description="Example of an invalid credentials error",
value={
"code": 1001,
"message": "Invalid credentials were provided.",
},
response_only=True,
)
],
),
401: OpenApiResponse(
description="Unauthorized",
examples=[
OpenApiExample(
name="TokenExpired",
description="Example of an expired token error",
value={"code": 1002, "message": "Token is invalid or expired."},
response_only=True,
)
],
),
},
)
@method_decorator(ratelimit(key="ip", rate="5/h")) @method_decorator(ratelimit(key="ip", rate="5/h"))
def post(self, request, *args, **kwargs): def post(self, request, *args, **kwargs):
try: try: