JH-135 add swagger

Author: JinHoooooou

v2/src/ctrlfbe/serializers.py

@@ -54,6 +54,10 @@ class NoteCreateRequestBodySerializer(serializers.Serializer):
     content = serializers.CharField()
 
 
+class TopicUpdateRequestBodySerializer(serializers.Serializer):
+    title = serializers.CharField()
+
+
 class NoteListQuerySerializer(serializers.Serializer):
     cursor = serializers.IntegerField()
 

v2/src/ctrlfbe/swagger.py

@@ -4,6 +4,7 @@
     NoteSerializer,
     PageSerializer,
     TopicSerializer,
+    TopicUpdateRequestBodySerializer,
 )
 
 SWAGGER_PAGE_LIST_VIEW = {
@@ -48,6 +49,13 @@
     "tags": ["디테일 화면"],
 }
 
+SWAGGER_TOPIC_UPDATE_VIEW = {
+    "operation_summary": "Topic Update API",
+    "operation_description": "topic_id에 해당하는 Topic의 제목을 수정합니다.",
+    "request_body": TopicUpdateRequestBodySerializer,
+    "tags": ["디테일 화면"],
+}
+
 SWAGGER_PAGE_DETAIL_VIEW = {
     "responses": {200: PageSerializer()},
     "operation_summary": "Page Detail API",

v2/src/ctrlfbe/views.py

@@ -9,6 +9,7 @@
     SWAGGER_PAGE_LIST_VIEW,
     SWAGGER_TOPIC_DETAIL_VIEW,
     SWAGGER_TOPIC_LIST_VIEW,
+    SWAGGER_TOPIC_UPDATE_VIEW,
 )
 from django.db.models import Model
 from drf_yasg.utils import swagger_auto_schema
@@ -116,6 +117,7 @@ class TopicDetailUpdateDeleteView(CtrlfAuthenticationMixin, BaseContentView):
     def get(self, request, *args, **kwargs):
         return super().get(request, *args, **kwargs)
 
+    @swagger_auto_schema(**SWAGGER_TOPIC_UPDATE_VIEW)
     def put(self, request, *args, **kwargs):
         ctrlf_user = self._ctrlf_authentication(request)
         topic = Topic.objects.get(id=kwargs["topic_id"])