Merge branch 'devdev' into feature/golony/status

Author: golony6449

pyconkr/settings.py

@@ -45,6 +45,8 @@
     # apps
     "sponsor",
     "status",
+    # swagger
+    "drf_spectacular",
 ]
 
 MIDDLEWARE = [
@@ -146,3 +148,25 @@
         "후원사 변동사항에 대한 알림을 보낼 채널",
     ),
 }
+
+# drf-spectacular
+REST_FRAMEWORK = {
+    # YOUR SETTINGS
+    "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
+}
+
+SPECTACULAR_SETTINGS = {
+    "TITLE": "pyconkr-api-v2",
+    "DESCRIPTION": "파이콘 한국 웹서비스용 API (2023 ~ )",
+    "VERSION": "1.0.0",
+    "SERVE_INCLUDE_SCHEMA": True,
+    # available SwaggerUI configuration parameters
+    # https://swagger.io/docs/open-source-tools/swagger-ui/usage/configuration/
+    "SWAGGER_UI_SETTINGS": {
+        "deepLinking": True,
+        "persistAuthorization": True,
+        "displayOperationId": True,
+    },
+    # available SwaggerUI versions: https://github.com/swagger-api/swagger-ui/releases
+    "SWAGGER_UI_DIST": "//unpkg.com/[email protected]",
+}

pyconkr/urls.py

@@ -13,8 +13,14 @@
     1. Import the include() function: from django.urls import include, path
     2. Add a URL to urlpatterns:  path('blog/', include('blog.urls'))
 """
+from django.conf import settings
 from django.contrib import admin
 from django.urls import include, path
+from drf_spectacular.views import (
+    SpectacularAPIView,
+    SpectacularRedocView,
+    SpectacularSwaggerView,
+)
 
 import sponsor.routers
 import status.urls
@@ -26,3 +32,19 @@
     path("sponsors/", include(sponsor.routers.get_router().urls)),
     path("status/", include(status.urls)),
 ]
+
+if settings.DEBUG is True:
+    urlpatterns += [
+        path("api/schema/", SpectacularAPIView.as_view(), name="schema"),
+        # Optional UI:
+        path(
+            "api/schema/swagger-ui/",
+            SpectacularSwaggerView.as_view(url_name="schema"),
+            name="swagger-ui",
+        ),
+        path(
+            "api/schema/redoc/",
+            SpectacularRedocView.as_view(url_name="schema"),
+            name="redoc",
+        ),
+    ]

requirements.txt

@@ -14,3 +14,4 @@ django-summernote==0.8.20.0
 Pillow==9.4.0
 django-constance==2.9.1
 django-picklefield==3.1
+drf-spectacular==0.25.1

sponsor/validators.py

@@ -0,0 +1,16 @@
+from collections import OrderedDict
+
+from sponsor.models import Sponsor
+
+
+class SponsorValidater:
+    def assert_create(self, sponsor: OrderedDict):
+        target = [self.check_remain_slot(sponsor)]
+
+    def check_remain_slot(self, sponsor: OrderedDict):
+        target_level = sponsor.get("level")
+
+        if target_level.limit <= len(
+            Sponsor.objects.filter(level=target_level, accepted=True)
+        ):
+            raise RuntimeError("ERROR: 남은 슬롯 없음")

sponsor/viewsets.py

@@ -1,5 +1,6 @@
 from typing import Type
 
+from django.db.transaction import atomic
 from django.shortcuts import get_object_or_404
 from rest_framework.response import Response
 from rest_framework.viewsets import ModelViewSet
@@ -12,12 +13,14 @@
     SponsorRemainingAccountSerializer,
     SponsorSerializer,
 )
+from sponsor.validators import SponsorValidater
 
 
 class SponsorViewSet(ModelViewSet):
     serializer_class = SponsorSerializer
     permission_classes = [IsOwnerOrReadOnly]  # 본인 소유만 수정가능
     http_method_names = ["get", "post"]  # 지금은 조회/등록만 가능 TODO: 추후 수정기능 추가
+    validator = SponsorValidater()
 
     def get_queryset(self):
         return Sponsor.objects.all()
@@ -27,10 +30,14 @@ def list(self, request, *args, **kwargs):
         serializer = SponsorListSerializer(queryset, many=True)
         return Response(serializer.data)
 
+    @atomic
     def create(self, request, *args, **kwargs):
         serializer = self.get_serializer(data=request.data)
         serializer.is_valid(raise_exception=True)
-        serializer.save()
+        self.validator.assert_create(serializer.validated_data)
+
+        new_sponsor = serializer.save()
+
         return Response(serializer.data)
 
     def retrieve(self, request, *args, **kwargs):