[FEAT] community 게시글 작성 swagger 명세 (#335)

* [FEAT] community 게시글 작성 swagger 명세 * [FIX] communityPost 파일명 수정
TeamHavit · Mar 20, 2024 · 6e1ea7b · 6e1ea7b
1 parent b552c51
commit 6e1ea7b
Show file tree

Hide file tree

Showing 3 changed files with 58 additions and 1 deletion.
diff --git a/functions/api/routes/community/communityPostPOST.js b/functions/api/routes/community/communityPostPOST.js
@@ -0,0 +1,9 @@
+/**
+ *  @route POST /community/posts
+ *  @desc 커뮤니티 게시글 작성
+ *  @access Private
+ */
+
+module.exports = async (req, res) => {
+  const { communityPostId } = req.body;
+};
diff --git a/functions/api/routes/community/index.js b/functions/api/routes/community/index.js
@@ -113,6 +113,36 @@ router.get(
     */
 );
 
+router.post(
+  '/posts',
+  checkUser,
+  require('./communityPostPOST'),
+  /**
+   * #swagger.summary = "커뮤니티 글 작성"
+   * #swagger.requestBody = {
+        required: true,
+        content: {
+            "application/json": {
+                schema:{
+                    $ref: "#/components/schemas/requestCreateCommunityPostSchema"
+                }
+            }
+        }
+    }
+   * #swagger.responses[201] = {
+        description: "커뮤니티 게시글 작성 성공",
+        content: {
+            "application/json": {
+                schema:{
+                    $ref: "#/components/schemas/responseCreateCommunityPostSchema"
+                }
+            }
+        }
+    }
+   * #swagger.responses[400]
+   */
+);
+
 router.post(
   '/report',
   checkUser,

diff --git a/functions/constants/swagger/schemas/communitySchema.js b/functions/constants/swagger/schemas/communitySchema.js
@@ -75,8 +75,24 @@ const responseCommunityPostsSchema = {
   },
 };
 
+const responseCreateCommunityPostSchema = {
+  $status: 201,
+  $success: true,
+  $message: '커뮤니티 게시글 작성 성공',
+};
+
+const requestCreateCommunityPostSchema = {
+  $communityCategoryIds: [1, 2, 3],
+  $title: '게시글 제목',
+  $body: '게시글 본문',
+  $contentUrl: '공유하는 콘텐츠 링크',
+  $contentTitle: '공유하는 콘텐츠 제목(og:title)',
+  contentDescription: '공유하는 콘텐츠 description(og:description)',
+  thumbnailUrl: '공유하는 콘텐츠 thumbnail(og:image)',
+};
+
 const responseCommunityReportSchema = {
-  $status: 200,
+  $status: 201,
   $success: true,
   $message: '커뮤니티 게시글 신고 성공',
 };
@@ -89,6 +105,8 @@ module.exports = {
   responseCommunityCategorySchema,
   responseCommunityPostsDetailSchema,
   responseCommunityPostsSchema,
+  responseCreateCommunityPostSchema,
+  requestCreateCommunityPostSchema,
   responseCommunityReportSchema,
   requestCommunityReportSchema,
 };