From d7ea67b0f493c43c20ce49baf3e58ff67774e154 Mon Sep 17 00:00:00 2001 From: sooieese Date: Thu, 7 Nov 2024 17:55:49 +0900 Subject: [PATCH] =?UTF-8?q?docs:=EB=B6=80=EC=8A=A4=EC=A6=90=EA=B2=A8?= =?UTF-8?q?=EC=B0=BE=EA=B8=B0=20=EB=93=B1=EB=A1=9D/=ED=95=B4=EC=A0=9C?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- build/swagger.yaml | 103 ++++++++++++++++++++++++++++++++ docs/booth-like-add-delete.yaml | 102 +++++++++++++++++++++++++++++++ docs/openapi.yaml | 2 + 3 files changed, 207 insertions(+) create mode 100644 docs/booth-like-add-delete.yaml diff --git a/build/swagger.yaml b/build/swagger.yaml index 89ef5de..9f1c9df 100644 --- a/build/swagger.yaml +++ b/build/swagger.yaml @@ -1669,3 +1669,106 @@ paths: message: type: string example: 검색 과정 중 오류가 발생했습니다. + /api/booth/: + post: + tags: + - Booth + summary: 부스 즐겨찾기 등록 + description: 특정 유저가 포토부스를 즐겨찾기에 등록합니다. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_id: + type: integer + description: 즐겨찾기에 등록할 유저의 ID + example: 1 + photobooth_id: + type: integer + description: 즐겨찾기에 등록할 포토부스의 ID + example: 101 + responses: + '200': + description: 포토부스 즐겨찾기 등록 성공 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 포토부스가 즐겨찾기 되었습니다. + '400': + description: 존재하지 않는 유저 또는 포토부스 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 존재하지 않는 유저거나 존재하지 않는 부스입니다. + '500': + description: 서버 오류 발생 시 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 즐겨찾기에 실패했습니다. + delete: + tags: + - Booth + summary: 부스 즐겨찾기 해제 + description: 특정 유저가 포토부스를 즐겨찾기에서 해제합니다. + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_id: + type: integer + description: 즐겨찾기에서 해제할 유저의 ID + example: 1 + photobooth_id: + type: integer + description: 즐겨찾기에서 해제할 포토부스의 ID + example: 101 + responses: + '200': + description: 포토부스 즐겨찾기 해제 성공 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 포토부스가 즐겨찾기 해제 되었습니다. + '400': + description: 존재하지 않는 유저 또는 포토부스 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 존재하지 않는 유저거나 존재하지 않는 부스입니다. + '500': + description: 서버 오류 발생 시 + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: 즐겨찾기 해제에 실패했습니다. diff --git a/docs/booth-like-add-delete.yaml b/docs/booth-like-add-delete.yaml new file mode 100644 index 0000000..5116f63 --- /dev/null +++ b/docs/booth-like-add-delete.yaml @@ -0,0 +1,102 @@ +post: + tags: + - Booth + summary: "부스 즐겨찾기 등록" + description: "특정 유저가 포토부스를 즐겨찾기에 등록합니다." + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_id: + type: integer + description: "즐겨찾기에 등록할 유저의 ID" + example: 1 + photobooth_id: + type: integer + description: "즐겨찾기에 등록할 포토부스의 ID" + example: 101 + responses: + 200: + description: "포토부스 즐겨찾기 등록 성공" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "포토부스가 즐겨찾기 되었습니다." + 400: + description: "존재하지 않는 유저 또는 포토부스" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "존재하지 않는 유저거나 존재하지 않는 부스입니다." + 500: + description: "서버 오류 발생 시" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "즐겨찾기에 실패했습니다." +delete: + tags: + - Booth + summary: "부스 즐겨찾기 해제" + description: "특정 유저가 포토부스를 즐겨찾기에서 해제합니다." + requestBody: + required: true + content: + application/json: + schema: + type: object + properties: + user_id: + type: integer + description: "즐겨찾기에서 해제할 유저의 ID" + example: 1 + photobooth_id: + type: integer + description: "즐겨찾기에서 해제할 포토부스의 ID" + example: 101 + responses: + 200: + description: "포토부스 즐겨찾기 해제 성공" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "포토부스가 즐겨찾기 해제 되었습니다." + 400: + description: "존재하지 않는 유저 또는 포토부스" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "존재하지 않는 유저거나 존재하지 않는 부스입니다." + 500: + description: "서버 오류 발생 시" + content: + application/json: + schema: + type: object + properties: + message: + type: string + example: "즐겨찾기 해제에 실패했습니다." diff --git a/docs/openapi.yaml b/docs/openapi.yaml index df6285b..5597714 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -51,3 +51,5 @@ paths: $ref: './photo-share.yaml' /api/photo/temp/update-info: $ref: './photo-searchBooth.yaml' + /api/booth/: + $ref: './booth-like-add-delete.yaml' \ No newline at end of file