Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
203 changes: 109 additions & 94 deletions src/main/resources/static/openapi.json
Original file line number Diff line number Diff line change
Expand Up @@ -42,30 +42,31 @@
"/auth": {
"post": {
"tags": ["Auth"],
"summary": "๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ",
"description": "๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค.",
"summary": "์นด์นด์˜ค ๋กœ๊ทธ์ธ",
"description": "์นด์นด์˜ค ๋กœ๊ทธ์ธ์„ ์ˆ˜ํ–‰ํ•ฉ๋‹ˆ๋‹ค. ID ํ† ํฐ๊ณผ provider ์ •๋ณด๋ฅผ ์ „๋‹ฌ๋ฐ›์•„ ์ธ์ฆ์„ ์ฒ˜๋ฆฌํ•ฉ๋‹ˆ๋‹ค.",
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SignInReq"
"$ref": "#/components/schemas/IdTokenReq"
}
}
}
},
"responses": {
"200": {
"description": "๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ ์„ฑ๊ณต",
"description": "์นด์นด์˜ค ๋กœ๊ทธ์ธ ์„ฑ๊ณต",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Message"
"$ref": "#/components/schemas/AuthRes"
}
}
}
},
"400": {
"description": "์ƒ์„ฑ ์‹คํŒจ",
"description": "๋กœ๊ทธ์ธ ์‹คํŒจ",
"content": {
"application/json": {
"schema": {
Expand Down Expand Up @@ -800,105 +801,106 @@
},
"components": {
"schemas": {
"SignInReq": {
"IdTokenReq": {
"type": "object",
"properties": {
"email": {
"idToken": {
"type": "string",
"description": "์ด๋ฉ”์ผ"
"description": "์นด์นด์˜ค์—์„œ ๋ฐœ๊ธ‰๋œ ID ํ† ํฐ"
},
"providerId": {
"provider": {
"type": "string",
"description": "๊ตฌ๊ธ€ ๋กœ๊ทธ์ธ ์‹œ ์ œ๊ณต๋˜๋Š” providerId"
"description": "'kakao'๋ฅผ ์ž…๋ ฅํ•ด์•ผ ํ•ฉ๋‹ˆ๋‹ค.",
"example": "kakao"
}
},
"required": ["token"]
},
"CreateWriteReq": {
"type": "object",
"properties": {
"verbType": {
"type": "integer",
"description": "ํ–ˆ์–ด์š” 0, ๋จน์—ˆ์–ด์š” 1, ๊ฐ”์–ด์š” 2",
"example": 0
},
"noun": {
"type": "string",
"description": "๋ช…์‚ฌ",
"example": "ํ—ฌ์Šค"
},
"record_image": {
"type": "string",
"description": "๊ธฐ๋ก ์ด๋ฏธ์ง€",
"example": "#$!~@#!@#!@213123"
}
"required": ["idToken", "provider"]
},
"CreateWriteReq": {
"type": "object",
"properties": {
"verbType": {
"type": "integer",
"description": "ํ–ˆ์–ด์š” 0, ๋จน์—ˆ์–ด์š” 1, ๊ฐ”์–ด์š” 2",
"example": 0
},
"noun": {
"type": "string",
"description": "๋ช…์‚ฌ",
"example": "ํ—ฌ์Šค"
},
"record_image": {
"type": "string",
"description": "๊ธฐ๋ก ์ด๋ฏธ์ง€",
"example": "#$!~@#!@#!@213123"
}
},
"RetrieveMyRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "๊ธฐ๋ก ์ƒ์„ฑ ๊ฑด์ˆ˜",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "์ตœ๊ณ  ์—ฐ์† ๊ธฐ๋ก",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "ํ‰๊ท  ์ผ๊ฐ„ ๊ธฐ๋ก",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "์ผ์ผ ์ตœ๋‹ค ๊ธฐ๋ก",
"example": 2
}
}
},
"RetrieveMyRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "๊ธฐ๋ก ์ƒ์„ฑ ๊ฑด์ˆ˜",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "์ตœ๊ณ  ์—ฐ์† ๊ธฐ๋ก",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "ํ‰๊ท  ์ผ๊ฐ„ ๊ธฐ๋ก",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "์ผ์ผ ์ตœ๋‹ค ๊ธฐ๋ก",
"example": 2
}
},
"RetrieveMyCalendarRes": {
"properties": {
"myRecordDate": {
"type": "string",
"description": "๊ธฐ๋ก ์ƒ์„ฑ ๋‚ ์งœ",
"example": "2024-11-23"
},
"numRecord": {
"type": "integer",
"description": "์ผ์ž๋ณ„ ๊ธฐ๋ก ๊ฐœ์ˆ˜",
"example": 5
}
}
},
"RetrieveMyCalendarRes": {
"properties": {
"myRecordDate": {
"type": "string",
"description": "๊ธฐ๋ก ์ƒ์„ฑ ๋‚ ์งœ",
"example": "2024-11-23"
},
"numRecord": {
"type": "integer",
"description": "์ผ์ž๋ณ„ ๊ธฐ๋ก ๊ฐœ์ˆ˜",
"example": 5
}
},
"RetrieveAllRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "์ด ๊ธฐ๋ก ์ƒ์„ฑ ๊ฑด์ˆ˜",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "์ตœ๊ณ  ์—ฐ์† ๊ธฐ๋ก",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "ํ‰๊ท  ์ผ๊ฐ„ ๊ธฐ๋ก",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "์ผ์ผ ์ตœ๋‹ค ๊ธฐ๋ก",
"example": 2
}
}
},
"RetrieveAllRecordRes": {
"properties": {
"recordNum": {
"type": "integer",
"description": "์ด ๊ธฐ๋ก ์ƒ์„ฑ ๊ฑด์ˆ˜",
"example": 2
},
"bestRecord": {
"type": "string",
"description": "์ตœ๊ณ  ์—ฐ์† ๊ธฐ๋ก",
"example": 30
},
"averageRecord": {
"type": "number",
"description": "ํ‰๊ท  ์ผ๊ฐ„ ๊ธฐ๋ก",
"example": 3.3
},
"dailyRecord": {
"type": "integer",
"description": "์ผ์ผ ์ตœ๋‹ค ๊ธฐ๋ก",
"example": 2
}
},
"RetrieveTotalTop5ListRes": {
"properties": {
"word": {
}
},
"RetrieveTotalTop5ListRes": {
"properties": {
"word": {
"type": "string",
"description": "๋‹จ์–ด",
"example": "๊ณต๋ถ€"
Expand Down Expand Up @@ -1234,6 +1236,19 @@
"description": "HTTP ์ƒํƒœ ์ฝ”๋“œ"
}
}
},
"AuthRes": {
"type": "object",
"properties": {
"accessToken": {
"type": "string",
"description": "'Bearer' ํ† ํฐ์œผ๋กœ ์‚ฌ์šฉ๋˜๋Š” ์•ก์„ธ์Šค ํ† ํฐ"
},
"isRegistered": {
"type": "boolean",
"description": "์‚ฌ์šฉ์ž๊ฐ€ ๋“ฑ๋ก๋˜์—ˆ๋Š”์ง€ ์—ฌ๋ถ€๋ฅผ ๋‚˜ํƒ€๋ƒ…๋‹ˆ๋‹ค"
}
}
}
}
}
Expand Down