📝 Api-docs : 해시태그 이름으로 질문글리스트 가져오기 api swagger 작성

earthkingman · Dec 16, 2021 · 906360d · 906360d
1 parent 026e039
commit 906360d
Show file tree

Hide file tree

Showing 2 changed files with 73 additions and 2 deletions.
diff --git a/backend/build/swagger.yaml b/backend/build/swagger.yaml
@@ -687,7 +687,7 @@ paths:
                 $ref: '#/components/schemas/MainPage'
         '404':
           description: Page doesn't exist
-  /pages/list/question/hashtag:
+  /pages/list/question/hashtag/id:
     get:
       summary: 해시태그 아이디로 질문글 리스트를 반환합니다.
       tags:
@@ -723,6 +723,41 @@ paths:
                 $ref: '#/components/schemas/MainPage'
         '404':
           description: Page doesn't exist
+  /pages/list/question/hashtag/name:
+    get:
+      summary: 해시태그 이름으로 질문글 리스트를 반환합니다.
+      tags:
+        - page
+      description: '데이터를 최신순으로 정렬하려면 orderBy = "time", 좋아요 순으로 정렬하려면 "like", 해결되지 않은 질문 리스트를 응답 받으려면 "solving" 사용'
+      parameters:
+        - name: pageNumber
+          in: query
+          schema:
+            type: integer
+            format: int64
+          example: 1
+          required: true
+        - name: hashtagName
+          in: query
+          schema:
+            type: string
+          example: ft_printf
+          required: true
+        - name: orderBy
+          in: query
+          schema:
+            type: string
+          example: time
+          required: true
+      responses:
+        '200':
+          description: 페이지 요청 성공
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/MainPage'
+        '404':
+          description: Page doesn't exist
   /pages/list/question/like:
     get:
       summary: 질문 리스트를 추천순으로 반환합니다.

diff --git a/backend/src/swagger/openapi.yaml b/backend/src/swagger/openapi.yaml
@@ -715,7 +715,7 @@ paths:
         "404":
           description: Page doesn't exist
 
-  /pages/list/question/hashtag:
+  /pages/list/question/hashtag/id:
     get:
       summary: 해시태그 아이디로 질문글 리스트를 반환합니다.
       tags:
@@ -752,6 +752,42 @@ paths:
         "404":
           description: Page doesn't exist
 
+  /pages/list/question/hashtag/name:
+    get:
+      summary: 해시태그 이름으로 질문글 리스트를 반환합니다.
+      tags:
+        - page
+      description: 데이터를 최신순으로 정렬하려면 orderBy = "time", 좋아요 순으로 정렬하려면 "like", 해결되지 않은 질문 리스트를 응답 받으려면 "solving" 사용
+      parameters:
+        - name: pageNumber
+          in: query
+          schema:
+            type: integer
+            format: int64
+          example: 1
+          required: true
+        - name: hashtagName
+          in: query
+          schema:
+            type: string
+          example: ft_printf
+          required: true
+        - name: orderBy
+          in: query
+          schema:
+            type: string
+          example: time
+          required: true
+      responses:
+        "200":
+          description: 페이지 요청 성공
+          content:
+            application/json:
+              schema:
+                $ref: "#/components/schemas/MainPage"
+        "404":
+          description: Page doesn't exist
+
   /pages/list/question/like:
     get:
       summary: 질문 리스트를 추천순으로 반환합니다.