accounts and config: add user list api, configurate swagger docs
This commit is contained in:
behruz
@@ -21,6 +21,32 @@ class LoginApiView(generics.GenericAPIView, ResponseMixin):
|
||||
|
||||
@swagger_auto_schema(
|
||||
tags=["auth"],
|
||||
operation_summary="Authenticate a user and returns access/refresh tokens",
|
||||
operation_description="""
|
||||
Authenticate a user using their login credentials and return JWT tokens.
|
||||
|
||||
Request:
|
||||
- Accepts user login credentials in JSON format.
|
||||
- The payload is validated using the LoginSerializer.
|
||||
|
||||
Process:
|
||||
- If the credentials are valid, the corresponding user is retrieved.
|
||||
- A pair of JWT tokens (access and refresh) is generated for the user.
|
||||
- User data and tokens are returned in the response.
|
||||
|
||||
Response:
|
||||
- 200 OK: Returns authenticated user details along with access and refresh tokens.
|
||||
- 400 Bad Request: Returned when validation fails (e.g., invalid credentials or missing fields).
|
||||
- 500 Internal Server Error: Returned if an unexpected error occurs during authentication.
|
||||
|
||||
Authentication:
|
||||
- This endpoint does not require authentication.
|
||||
- It is used to obtain new JWT tokens for authorized access to protected endpoints.
|
||||
|
||||
Notes:
|
||||
- The response includes both user profile data and JWT token pair.
|
||||
- Make sure to store the refresh token securely for token renewal flows.
|
||||
""",
|
||||
responses={
|
||||
200: openapi.Response(
|
||||
description="Success",
|
||||
|
||||
@@ -23,6 +23,23 @@ class CreateUserApiView(generics.GenericAPIView, ResponseMixin):
|
||||
|
||||
@swagger_auto_schema(
|
||||
tags=['user'],
|
||||
operation_summary="Api for create employees",
|
||||
operation_description="""
|
||||
Create a new user account.
|
||||
|
||||
Request Body:
|
||||
- Requires user details based on the serializer fields.
|
||||
- All required fields must be provided in MULTIPART/DATA format.
|
||||
|
||||
Behavior:
|
||||
- Validates the incoming data using the serializer.
|
||||
- If validation succeeds, a new user is created and returned.
|
||||
- If validation fails, an appropriate error message is returned.
|
||||
|
||||
Response:
|
||||
- On success: Returns the newly created user object with a success message.
|
||||
- On error: Returns validation or processing error details.
|
||||
""",
|
||||
responses={
|
||||
201: openapi.Response(
|
||||
description="Created",
|
||||
@@ -44,7 +61,31 @@ class CreateUserApiView(generics.GenericAPIView, ResponseMixin):
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
),
|
||||
400: openapi.Response(
|
||||
description="Failure",
|
||||
schema=None,
|
||||
examples={
|
||||
"application/json": {
|
||||
"status_code": 400,
|
||||
"status": "failure",
|
||||
"message": "Kiritayotgan malumotingizni tekshirib ko'ring",
|
||||
"data": "string"
|
||||
}
|
||||
}
|
||||
),
|
||||
500: openapi.Response(
|
||||
description="Error",
|
||||
schema=None,
|
||||
examples={
|
||||
"application/json": {
|
||||
"status_code": 500,
|
||||
"status": "error",
|
||||
"message": "Xatolik, Iltimos backend dasturchiga murojaat qiling",
|
||||
"data": "string"
|
||||
}
|
||||
}
|
||||
),
|
||||
}
|
||||
)
|
||||
def post(self, request):
|
||||
|
||||
107
core/apps/accounts/views/user/list.py
Normal file
107
core/apps/accounts/views/user/list.py
Normal file
@@ -0,0 +1,107 @@
|
||||
# rest framework
|
||||
from rest_framework import generics, permissions
|
||||
|
||||
# drf yasg
|
||||
from drf_yasg import openapi
|
||||
from drf_yasg.utils import swagger_auto_schema
|
||||
|
||||
|
||||
# accounts
|
||||
from core.apps.accounts.models import User
|
||||
from core.apps.accounts.serializers.user import ListUserSerializer
|
||||
|
||||
# utils
|
||||
from core.utils.response.mixin import ResponseMixin
|
||||
|
||||
|
||||
class ListUserApiView(generics.GenericAPIView, ResponseMixin):
|
||||
serializer_class = ListUserSerializer
|
||||
queryset = User.objects.all()
|
||||
permission_classes = [permissions.IsAuthenticated]
|
||||
|
||||
@swagger_auto_schema(
|
||||
tags=['user'],
|
||||
operation_summary="Api for get list of employees",
|
||||
operation_description="""
|
||||
Retrieve a paginated list of employees.
|
||||
|
||||
Authentication:
|
||||
- This endpoint requires a valid Bearer access token in the Authorization header.
|
||||
|
||||
Query Parameters:
|
||||
- limit (integer, optional): Maximum number of results per page. Default: 10.
|
||||
- offset (integer, optional): Position of the page to start retrieving results from. Default: 0.
|
||||
|
||||
Response:
|
||||
- Returns a list of employees, including basic employee information and pagination details (count, next, previous).
|
||||
- Data is returned in JSON format.
|
||||
""",
|
||||
responses={
|
||||
200: openapi.Response(
|
||||
description="Success",
|
||||
schema=None,
|
||||
examples={
|
||||
"application/json": {
|
||||
"status_code": 200,
|
||||
"status": "success",
|
||||
"message": "Users list",
|
||||
"data": {
|
||||
"count": 0,
|
||||
"next": "string",
|
||||
"previous": "string",
|
||||
"results": [
|
||||
{
|
||||
"id": 0,
|
||||
"first_name": "string",
|
||||
"last_name": "string",
|
||||
"username": "string",
|
||||
"phone_number": "string",
|
||||
"profile_image": "string",
|
||||
"created_at": "string",
|
||||
"updated_at": "string",
|
||||
"is_active": True,
|
||||
"role": {
|
||||
"id": 0,
|
||||
"name": "string",
|
||||
},
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
}
|
||||
),
|
||||
500: openapi.Response(
|
||||
description="Error",
|
||||
schema=None,
|
||||
examples={
|
||||
"application/json": {
|
||||
"status_code": 500,
|
||||
"status": "error",
|
||||
"message": "Xatolik, Iltimos backend dasturchiga murojaat qiling",
|
||||
"data": "string"
|
||||
}
|
||||
}
|
||||
)
|
||||
},
|
||||
manual_parameters=[],
|
||||
)
|
||||
def get(self, request):
|
||||
try:
|
||||
queryset = self.queryset.select_related('role')
|
||||
page = self.paginate_queryset(queryset)
|
||||
print(page)
|
||||
if page is not None:
|
||||
serializer = self.serializer_class(page, many=True)
|
||||
return self.success_response(
|
||||
data=self.get_paginated_response(serializer.data).data,
|
||||
message="Users list"
|
||||
)
|
||||
serializer = self.serializer_class(queryset, many=True)
|
||||
return self.success_response(
|
||||
data=serializer.data,
|
||||
message="Users list"
|
||||
)
|
||||
except Exception as e:
|
||||
return self.error_response(
|
||||
data=str(e),
|
||||
)
|
||||
@@ -30,7 +30,27 @@ class UserViewSet(viewsets.GenericViewSet, ResponseMixin):
|
||||
|
||||
@swagger_auto_schema(
|
||||
tags=['user'],
|
||||
operation_description="User malumotlarini olish uchun api",
|
||||
operation_summary="Get currently authenticated user's profile",
|
||||
operation_description="""
|
||||
Get information about the currently authenticated user.
|
||||
|
||||
Authentication:
|
||||
- This endpoint requires an active Bearer access token.
|
||||
|
||||
Process:
|
||||
- The system retrieves the user associated with the provided token.
|
||||
- The user's information is serialized using the configured serializer.
|
||||
- Returns the authenticated user's profile data.
|
||||
|
||||
Response:
|
||||
- 200 OK: Successfully returns user details.
|
||||
- 401 Unauthorized: Authorization header is missing or token is invalid.
|
||||
- 500 Internal Server Error: An unexpected error occurred.
|
||||
|
||||
Notes:
|
||||
- This endpoint does not require any request parameters.
|
||||
- Useful for fetching the current user's profile without needing an ID.
|
||||
""",
|
||||
responses={
|
||||
200: openapi.Response(
|
||||
description="Success",
|
||||
@@ -52,7 +72,19 @@ class UserViewSet(viewsets.GenericViewSet, ResponseMixin):
|
||||
}
|
||||
}
|
||||
}
|
||||
)
|
||||
),
|
||||
500: openapi.Response(
|
||||
description="Error",
|
||||
schema=None,
|
||||
examples={
|
||||
"application/json": {
|
||||
"status_code": 500,
|
||||
"status": "error",
|
||||
"message": "Xatolik, Iltimos backend dasturchiga murojaat qiling",
|
||||
"data": "string",
|
||||
}
|
||||
}
|
||||
),
|
||||
}
|
||||
)
|
||||
@action(
|
||||
|
||||
Reference in New Issue
Block a user