Skip to content

Commit

Permalink
[CHORE] swagger 수정
Browse files Browse the repository at this point in the history
  • Loading branch information
@leGit-y
leGit-y committed Dec 26, 2023
1 parent 39086be commit ac89cc6
Show file tree
Hide file tree
Showing 7 changed files with 439 additions and 129 deletions.
2 changes: 1 addition & 1 deletion package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"license": "MIT",
"scripts": {
"api-docs": "swagger-cli bundle ./src/modules/swagger/openapi.yaml --outfile swagger.yaml --type yaml",
"predev": "npm run api-docs",
"preproduction": "npm run api-docs",
"development": "dotenv -e .env.development nodemon",
"production": "dotenv -e .env.production nodemon",
"build": "tsc",
Expand Down
27 changes: 26 additions & 1 deletion src/modules/swagger/auth.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,8 @@
schema:
type: object
example: {
"accessToken" : "카카오 액세스토큰"
"accessToken" :"카카오 액세스토큰",
"deviceToken" :"fcm 디바이스토큰"
}
responses:
'200':
Expand Down Expand Up @@ -179,5 +180,29 @@
}
'400':
$ref: './openapi.yaml#/components/responses/BadRequest'
'500':
$ref: './openapi.yaml#/components/responses/InternalServerError'

/auth/unregister:
delete:
tags:
- Auth
summary: 회원탈퇴하기
consumes:
- application/json
responses:
'200':
description: 회원 탈퇴 성공
content:
application/json:
schema:
type: object
example: {
"status": 200,
"success": true,
"message": "회원 탈퇴 성공",
}
'400':
$ref: './openapi.yaml#/components/responses/BadRequest'
'500':
$ref: './openapi.yaml#/components/responses/InternalServerError'
8 changes: 6 additions & 2 deletions src/modules/swagger/openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,12 @@ paths:
#auth
/auth/kakao/login:
$ref: './auth.yaml#/~1auth~1kakao~1login'
/auth/apple/login:
$ref: './auth.yaml#/~1auth~1apple~1login'
/auth/token/refresh:
$ref: './auth.yaml#/~1auth~1token~1refresh'
/auth/unregister:
$ref: './auth.yaml#/~1auth~1unregister'

#template
/template:
Expand All @@ -35,8 +39,8 @@ paths:
$ref: './worry.yaml#/~1worry~1finalAnswer'
/worry/deadline:
$ref: './worry.yaml#/~1worry~1deadline'
/worry/list/{isSolved}:
$ref: './worry.yaml#/~1worry~1list~1{isSolved}'
/worry/{isSolved}/list?page={page}&limit={limit}:
$ref: './worry.yaml#/~1worry~1{isSolved}~1list'
/worry?templateId={templateId}:
$ref: './worry.yaml#/~1worry?templateId={templateId}'

Expand Down
2 changes: 1 addition & 1 deletion src/modules/swagger/review.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ components:
example: {
"status": 200,
"success": true,
"message": "나의 기록 등록 및 수정 성공",
"message": "나의 기록 등록/수정 성공",
"data": {
"updatedAt" : "2019-10-01"
}
Expand Down
30 changes: 15 additions & 15 deletions src/modules/swagger/template.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -76,24 +76,24 @@
schema:
type: object
example: {
"status": 200,
"status": 200,
"success": true,
"message": "템플릿 조회 성공",
"data": {
"title": "걱정을 극복하는 자기 관리론",
"guideline": "고민의 장단점을 비교하며 깊게 생각해보세요.",
"questions": [
"고민의 선택지를 나열해보세요.",
"선택지들의 장점을 생각해보세요",
"선택지들의 단점을 생각해보세요.",
"장점과 단점을 비교해보세요!",
],
"hints": [
"걱정하고 있는 걸 사실대로 써봅시다." ,
"내가 지금 할 수 있는 해결방안이나 행동을 적어봅시다." ,
"내가 선택한 방법을 적어봅시다." ,
"내가 선택한 방법을 적어봅시다."
]
"title": "장단점 생각하기",
"guideline": "A or B? 결정이 어렵다면, 장단점을 비교해 최선을 찾아봐요.",
"questions": [
"고민의 선택지를 나열해보세요.",
"선택지들의 장점을 생각해보세요.",
"선택지들의 단점을 생각해보세요.",
"장점과 단점을 비교해 최선의 방법을 찾아보세요."
],
"hints": [
"예) 휴학하고 스펙 쌓기 vs 학교 생활하기",
"예) 휴학: 시간을 여유롭게 활용할 수 있다\n 학교: 칼졸업 가능!",
"예) 휴학: 비효율적인 시간 관리가 우려된다\n 학교: 취업 준비의 여유가 없다",
"예) 휴학 기간 동안 참여할 대외활동 리스트를 세워두자"
]
}
}
'400':
Expand Down
213 changes: 161 additions & 52 deletions src/modules/swagger/worry.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -61,25 +61,25 @@ components:
examples:
postWorryBodyExampleDeadline:
value: {
"templateId": 1,
"title": "졸업후의 나",
"templateId": 2,
"title": "고민고민",
"answers": [
"11이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"22이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"33이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"44이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다."
"a",
"b",
"c",
"d"
],
"deadline": 5
"deadline": 6
}
postWorryBodyExampleNoDeadline:
value: {
"templateId": 1,
"title": "졸업후의 나",
"templateId": 2,
"title": "고민고민",
"answers": [
"11이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"22이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"33이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.",
"44이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다.이번 시험 망칠까봐 걱정된다."
"a",
"b",
"c",
"d"
],
"deadline": -1
}
Expand Down Expand Up @@ -137,15 +137,47 @@ components:
application/json:
schema:
type: object
example: {
"status": 200,
"success": true,
"message": "고민 작성 성공",
"data": {
"createdAt": "2023-07-22",
"deadline": "2023-07-27"
examples:
withDeadline:
value: {
"status": 200,
"success": true,
"message": "고민 생성 성공",
"data": {
"worryId": 524,
"title": "고민고민",
"templateId": 2,
"answers": [
"a",
"b",
"c",
"d"
],
"createdAt": "2023-12-21",
"deadline": "2023-12-27",
"dDay": -6
}
}
withNoDeadline:
value: {
"status": 200,
"success": true,
"message": "고민 생성 성공",
"data": {
"worryId": 524,
"title": "고민고민",
"templateId": 2,
"answers": [
"a",
"b",
"c",
"d"
],
"createdAt": "2023-12-21",
"deadline": "데드라인이 없습니다",
"dDay": -888
}
}
}
'400':
$ref: './openapi.yaml#/components/responses/BadRequest'
'500':
Expand Down Expand Up @@ -242,35 +274,101 @@ components:
application/json:
schema:
type: object
example: {
"status": 200,
"success": true,
"message": "고민 상세조회 성공",
"data": {
"title": "고민1",
"templateId": 1,
"subtitles":[
"소제목1",
"소제목2",
"소제목3",
"소제목4",
],
"answers":[
"답변1",
"답변2",
"답변3",
"답변4",
],
"period": "2020-01-01 ~ 2020-03-03",
"updatedAt": "2020-03-03",
"deadline": "2020-03-02",
"finalAnswer": "해카라쿠배 지원하기",
"review":{
"content":"나의 후기~!~!",
"updatedAt": "2020-04-23"
}
examples:
notFinishedWorry:
value: {
"status": 200,
"success": true,
"message": "고민 상세조회 성공",
"data": {
"title": "고민고민",
"templateId": 2,
"subtitles": [
"고민의 선택지",
"선택지의 장점",
"선택지의 단점",
"장점과 단점의 비교"
],
"answers": [
"a",
"b",
"c",
"d"
],
"period": "아직 고민중인 글입니다.",
"updatedAt": "2023-12-21",
"deadline": "2023-12-27",
"dDay": -6,
"finalAnswer": "",
"review": {
"content": "",
"updatedAt": ""
}
}
}
}
finishedWorryWithNoReview:
value: {
"status": 200,
"success": true,
"message": "고민 상세조회 성공",
"data": {
"title": "12/21일에 생성",
"templateId": 4,
"subtitles": [
"고민의 최종 목표",
"목표를 위한 준비",
"올해 안에 할 수 있는 실천",
"오늘 당장 할 수 있는 실천"
],
"answers": [
"a",
"b",
"c",
"d"
],
"period": "2023-12-21 ~ 2023-12-21",
"updatedAt": "2023-12-21",
"deadline": "데드라인이 없습니다.",
"dDay": -888,
"finalAnswer": "결정했다..!",
"review": {
"content": "",
"updatedAt": "2023-12-21"
}
}
}
finishedWorryWithReview:
value: {
"status": 200,
"success": true,
"message": "고민 상세조회 성공",
"data": {
"title": "12/20일에 생성",
"templateId": 4,
"subtitles": [
"고민의 최종 목표",
"목표를 위한 준비",
"올해 안에 할 수 있는 실천",
"오늘 당장 할 수 있는 실천"
],
"answers": [
"a",
"b",
"c",
"d"
],
"period": "2023-12-20 ~ 2023-12-21",
"updatedAt": "2023-12-21",
"deadline": "2023-12-26",
"dDay": 0,
"finalAnswer": "결정했다..!",
"review": {
"content": "리뷰",
"updatedAt": "2023-12-21"
}
}
}

'400':
$ref: './openapi.yaml#/components/responses/BadRequest'
'500':
Expand Down Expand Up @@ -344,15 +442,16 @@ components:
schema:
type: object
example: {
"status": 200,
"status": 200,
"success": true,
"message": "데드라인 수정 성공",
"data": {
"deadline": "2023-12-12"
"deadline": "2023-12-31",
"dDay": -5
}
}

/worry/list/{isSolved}:
/worry/{isSolved}/list:
get:
tags:
- Worry
Expand All @@ -364,6 +463,16 @@ components:
description: 고민해결 여부
schema:
type: string
- in: query
name: page
schema:
type: string
required: true
- in: query
name: limit
schema:
type: string
required: true
responses:
'200':
description: 고민목록 조회 성공
Expand Down
Loading

0 comments on commit ac89cc6

Please sign in to comment.