[fix] swagger before build

COW-dev · Nov 20, 2023 · 6606cf3 · 6606cf3
1 parent cc25391
commit 6606cf3
Show file tree

Hide file tree

Showing 2 changed files with 102 additions and 13 deletions.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
@@ -20,7 +20,7 @@ jobs:
           cache: "gradle"
 
       - name: Build with Gradle
-        run: ./gradlew clean build --no-daemon --exclude-task test
+        run: ./gradlew clean openapi3 build --no-daemon --exclude-task test
 
       - name: Login To DockerHub
         uses: docker/login-action@v3

diff --git a/src/main/resources/static/swagger-ui/openapi3.yaml b/src/main/resources/static/swagger-ui/openapi3.yaml
@@ -7,6 +7,52 @@ servers:
 - url: http://localhost:8080
 tags: []
 paths:
+  /api/v1/banners:
+    get:
+      tags:
+      - banner
+      summary: 배너 전체 조회
+      description: 배너 전체 조회
+      operationId: banner-findAll
+      responses:
+        "200":
+          description: "200"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/api-v1-categories-category-id486549215'
+              examples:
+                banner-findAll:
+                  value: "{\"message\":null,\"body\":[{\"id\":1,\"link\":\"https://career.programmers.co.kr/competitions/3353\"\
+                    ,\"imageAddress\":\"/banner/232D8241-C6A9-4AD9-B0EA-56F6DD24BADF.png\"\
+                    ,\"expiredAt\":\"2023-11-21T14:11:34.639184Z\",\"createdAt\":\"\
+                    2023-11-20T14:11:52.114906Z\"}]}"
+    post:
+      tags:
+      - banner
+      summary: 배너 생성
+      description: 배너 생성
+      operationId: banner-create
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/api-v1-categories-category-id486549215'
+            examples:
+              banner-create:
+                value: "{\"link\":\"https://career.programmers.co.kr/competitions/3353\"\
+                  ,\"imageAddress\":\"/banner/232D8241-C6A9-4AD9-B0EA-56F6DD24BADF.png\"\
+                  ,\"expiredAt\":1700575894.639184000}"
+      responses:
+        "201":
+          description: "201"
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/api-v1-categories-category-id486549215'
+              examples:
+                banner-create:
+                  value: "{\"message\":null,\"body\":4843367494315138152}"
   /api/v1/categories:
     get:
       tags:
@@ -23,10 +69,10 @@ paths:
                 $ref: '#/components/schemas/api-v1-categories-category-id486549215'
               examples:
                 category-findAll:
-                  value: "{\"message\":null,\"body\":[{\"id\":6003997120884358728,\"\
-                    name\":\"3d84e31c-7aeb-4f49-bd41-4bec2ac5e2c0\"},{\"id\":1319124374454579397,\"\
-                    name\":\"bad46b25-51b5-40e6-a3e5-bb5b2626c1f8\"},{\"id\":2540042240158473045,\"\
-                    name\":\"f28319bb-72dc-41b1-b3d5-d5555142559e\"}]}"
+                  value: "{\"message\":null,\"body\":[{\"id\":8608100422551522095,\"\
+                    name\":\"87de5dc8-c3b8-419e-ae63-9e2878482a39\"},{\"id\":2343467381135403541,\"\
+                    name\":\"9722e43c-bf83-4a33-817b-fec028419260\"},{\"id\":4900245127042464096,\"\
+                    name\":\"32eda463-06f4-43c8-b953-05db6ae6295b\"}]}"
     post:
       tags:
       - category
@@ -50,7 +96,7 @@ paths:
                 $ref: '#/components/schemas/api-v1-categories-category-id486549215'
               examples:
                 category-create:
-                  value: "{\"message\":null,\"body\":6618719034599165780}"
+                  value: "{\"message\":null,\"body\":9028569975075608962}"
   /api/v1/notices:
     get:
       tags:
@@ -68,7 +114,7 @@ paths:
               examples:
                 notice-findAll:
                   value: "{\"message\":null,\"body\":[{\"id\":1,\"title\":\"공지사항 제\
-                    목\",\"content\":\"공지사항 내용\",\"createdAt\":\"2023-10-15T07:11:23.464310Z\"\
+                    목\",\"content\":\"공지사항 내용\",\"createdAt\":\"2023-11-20T14:11:52.925060Z\"\
                     }]}"
     post:
       tags:
@@ -93,7 +139,7 @@ paths:
                 $ref: '#/components/schemas/api-v1-categories-category-id486549215'
               examples:
                 notice-create:
-                  value: "{\"message\":null,\"body\":8015117190019776893}"
+                  value: "{\"message\":null,\"body\":2058921043891802126}"
   /api/v1/stores:
     get:
       tags:
@@ -174,6 +220,49 @@ paths:
               examples:
                 store-create:
                   value: "{\"message\":null,\"body\":1}"
+  /api/v1/banners/{bannerId}:
+    delete:
+      tags:
+      - banner
+      summary: 배너 삭제
+      description: 배너 삭제
+      operationId: banner-delete
+      parameters:
+      - name: bannerId
+        in: path
+        description: ""
+        required: true
+        schema:
+          type: string
+      responses:
+        "204":
+          description: "204"
+    patch:
+      tags:
+      - banner
+      summary: 배너 수정
+      description: 배너 수정
+      operationId: banner-update
+      parameters:
+      - name: bannerId
+        in: path
+        description: ""
+        required: true
+        schema:
+          type: string
+      requestBody:
+        content:
+          application/json:
+            schema:
+              $ref: '#/components/schemas/api-v1-categories-category-id486549215'
+            examples:
+              banner-update:
+                value: "{\"link\":\"https://career.programmers.co.kr/competitions/3353\"\
+                  ,\"imageAddress\":\"/banner/232D8241-C6A9-4AD9-B0EA-56F6DD24BADF.png\"\
+                  ,\"expiredAt\":1700575894.639184000}"
+      responses:
+        "200":
+          description: "200"
   /api/v1/categories/{category-id}:
     delete:
       tags:
@@ -238,8 +327,8 @@ paths:
                 $ref: '#/components/schemas/api-v1-categories-category-id486549215'
               examples:
                 category-findById:
-                  value: "{\"message\":null,\"body\":{\"id\":4853986537579592968,\"\
-                    name\":\"a81b3a6b-8fb4-4af4-9388-493943516812\"}}"
+                  value: "{\"message\":null,\"body\":{\"id\":4631017781137326803,\"\
+                    name\":\"3ef8845e-4089-41a4-a393-d00aa8386d85\"}}"
   /api/v1/menu/{menuId}:
     get:
       tags:
@@ -329,7 +418,7 @@ paths:
               examples:
                 notice-findById:
                   value: "{\"message\":null,\"body\":{\"id\":1,\"title\":\"공지사항 제목\
-                    \",\"content\":\"공지사항 내용\",\"createdAt\":\"2023-10-15T07:11:23.936628Z\"\
+                    \",\"content\":\"공지사항 내용\",\"createdAt\":\"2023-11-20T14:11:53.025126Z\"\
                     }}"
     delete:
       tags:
@@ -443,7 +532,7 @@ paths:
   /api/v1/stores/{storeId}/menu:
     get:
       tags:
-      - Store
+      - store
       summary: 가게의 메뉴 전체 조회
       description: 가게의 메뉴 전체 조회
       operationId: store-findAllMenu
@@ -466,7 +555,7 @@ paths:
                   value: "{\"message\":null,\"body\":[]}"
     post:
       tags:
-      - Store
+      - store
       summary: 가게의 메뉴 생성
       description: 가게의 메뉴 생성
       operationId: menu-create