dnd-side-project / dnd-10th-6-backend Goto Github PK
View Code? Open in Web Editor NEW๐ฒ ๋๋ฌด๋ก ๋ณด๋ ๋จ์ด ์จ์ฃผ๋ ๋์ ์๊ฐ์, ๋จ์์ํค(namui wiki)
๐ฒ ๋๋ฌด๋ก ๋ณด๋ ๋จ์ด ์จ์ฃผ๋ ๋์ ์๊ฐ์, ๋จ์์ํค(namui wiki)
๋ด๊ฐ ์์ฑํ ์ค๋ฌธ ์กฐํ API ๊ตฌํํฉ๋๋ค.
GET
/users/profile/surveys?pageSize&pageNo&period&relationResponse
{
data: {
"page": 0,
"size": 20,
"totalPage": 1,
"totalCount": 2,
"content": [
{
"surveyId": "asdf",
"relation": "ELEMENT",
"period": "period",
"recieverName": "string",
"sendedAt": "2022-10-10T00:00:00"
},
...
]
}
}
AS-IS
ํ์๊ฐ์
๊ธฐ์ค : ์ต์ด ๋ก๊ทธ์ธ ์
์นด์นด์ค ๋ก๊ทธ์ธ ์๋ฃ ์, ์ต์ด ๋ก๊ทธ์ธ์ผ ๊ฒฝ์ฐ ํ์๊ฐ์
์นด์นด์ค์์ ์ ์ ์ ๋ณด ์กฐํํ์ฌ ๋๋ค์ ๊ฐ์ ธ์ ๋ํดํธ ๋๋ค์์ผ๋ก ์ค์
TO-BE
ํ์๊ฐ์
๊ธฐ์ค : ์ต์ด ๋ก๊ทธ์ธ + ๋๋ค์ ์
๋ ฅ ์๋ฃ
์นด์นด์ค ๋ก๊ทธ์ธ ์๋ฃ ์
๊ธฐ์กด ์ ์ ๋ผ๋ฉด accessToken๊ณผ refreshToken ์๋ต
์ ๊ท ๊ฐ์
์ ์ ๋ผ๋ฉด HTTP status 404 ์ฝ๋์ ํจ๊ป ์ฟ ํค๋ก kakao oauth accessToken์ ์ค์ ํ์ฌ ์๋ต
(client) ์ด ๊ฒฝ์ฐ ํ์๊ฐ์
ํ์ด์ง๋ก ์ด๋
/api/v1/signup API๋ฅผ ์ด์ฉํ์ฌ ํ์๊ฐ์
์ ์ ๊ฐ ์
๋ ฅํ ๋๋ค์๊ณผ set-cookie๋ก ์ค์ ๋ ์ฟ ํค์ ํจ๊ป ์์ฒญ
(server) accessToken ์ผ๋ก ์ ์ ์ ๋ณด ์กฐํ ํ ํ์๊ฐ์
์๋ฃ
statistcis ๋๋ฉ์ธ์์ ์ฌ์ฉ๋์ง ์๋ ์๋ 2๊ฐ์ง๋ฅผ dashboard ๋๋ฉ์ธ์ผ๋ก ์ด๋ํฉ๋๋ค.
์ ์ ํ๋กํ ์กฐํ api
db์ ์ ์ฒด ์ปฌ๋ ์ ์ด updatedAt, createdAt ํ๋ ์ถ๊ฐ
Question์ reason required ํ๋ ์ถ๊ฐํฉ๋๋ค.
์ ์ฒด ๋ฌธํญ์ ์กฐํํ ์ ์๋ค.
/**** ๋ฌธํญ(question) ****/
MULTIPLE_CHOICE : ์ ์ง๊ฐ 3๊ฐ ์ด์
OX : ์ ์ง๊ฐ 2๊ฐ
SHORT_ANSWER : 15์ ์ดํ
NUMBER : ์ซ์
// ESSAY : 15์ ์ด๊ณผ
// ๋ค์ค์ ํ
{
"id": 1,
"title": "string",
"question_type":"MULTIPLE_CHOICE",
"options": [
"A", "B", "C"
]
}
{
"title": "string",
"question_type":"OX",
"options": [
"O", "X"
]
}
{
"title": "string",
"question_type":"SHORT_ANSWER"
}
{
"title": "string",
"question_type":"NUMBER",
"options": [
0, 1000
]
}
/**** ์ ์ง(option) ****/
{
"id": "id",
"content": "string"
}
{
"id": "docuemtn id",
"content": "MANUAL"
}
๋ด๊ฐ ์๋ ๋ค๋ฅธ ์ฌ๋์ด ๋์ ์ค๋ฌธ์ ์์ฑํ ์ ์๋ค.
/**** ์ค๋ฌธ(survey) ****/
- pk - id
- fk ํด์ค ์ฌ์ฉ์ - null
- fk ๋ฐ์ ์ฌ์ฉ์
- ๋ต๋ณ[]
- ๋ฌธํญ id
- answer(์ง๋ฌธ ์ ํ๋ณ๋ก ๊ตฌ์กฐ ๋ค๋ฆ)
// type
// manual : ๋ค์ง์ ๋ค์ ์ง์ ์
๋ ฅ, ์ฃผ๊ด์ -> answer : ํ
์คํธ or ์ซ์
// option : OX, ๋ค์ง์ ๋ค์ ์ ์ง -> answer : option id
{
"id": "pk",
"owner":"user id",
"sender":"user id or null",
"period": "string",
"relation": "string",
"answers": [
{ "question_id": "id", "type": "manual | option", "answer": "docuemtn id" }
],
"reason": "string"
}
{
"id": "pk",
"owner":"user id",
"sender":"user id or null",
"answers": [
{ "question_id": "id", "answer": "option document id" }
],
"reason": "string"
}
Period
SIX_MONTHS
ONE_YEAR
FOUR_YEARS
INFINITE
Relation
ELEMENTARY_SCHOOL
MIDDLE_AND_HIGH_SCHOOL
UNIVERSITY
WORK
SOCIAL
ETC
question ์์๊ฐ ๋ณด์ฅ๋์ง ์์ pair question answer์์ ์ค๋ฅ๋ฐ์
์ต๋ช
ํ๋๊ฐ ์ ๊ฑฐ๋จ์ ๋ฐ๋ผ, request์์ isAnonymous
ํ๋๋ฅผ ์ ๊ฑฐํฉ๋๋ค.
์ ์ ํผ๋ธ๋ฆญ ์ ๋ณด ์กฐํ api ๊ตฌํํฉ๋๋ค.
๋น๋ฆด ์ ์๋ ๊ธ์ก MANUALํ์ ์ผ ๊ฒฝ์ฐ locale๋ก ๋ณํํ๊ณ "์"์ ๋ถ์ฌ์ ์๋ตํฉ๋๋ค.
JDK 21 ๋ฒ์ ํจ์๊ฐ ์ฌ์ฉ๋ ๊ณณ์ด ์์ต๋๋ค.
17์ ๋ง์ถฐ ์์ ํฉ๋๋ค.
Oauth ๋ก๊ทธ์ธ ์ ํ์ ๊ฐ์ ์ฌ๋ถ ํ๋จํ์ฌ ์๋ตํฉ๋๋ค.
ํ์๊ฐ์
์ด ๋์ด ์์ ์, ๊ธฐ์กด๊ณผ ๋์ผํ๊ฒ accessToken๊ณผ refreshToken์ ์๋ตํฉ๋๋ค.
์๋ ์, 404 http status๋ฅผ oauth provider์ oauth accesstoken๊ณผ ํจ๊ป ์๋ตํฉ๋๋ค.
์นด์นด์ค oauth ๋ก๊ทธ์ธ์ ์ฌ์ฉํ์ฌ ์ฌ์ฉ์๋ฅผ ์ธ์ฆํ๋ค.
POST
/api/v1/login
code
๋ฅผ ํตํด ์นด์นด์ค oauth ์๋ฒ์ token์ ์์ฒญํ๋ค.token
์ ํตํด ์นด์นด์ค oauth ์๋ฒ์ ์ฌ์ฉ์ ์๋ณ์๋ฅผ ์กฐํํ๋ค.Request Body
{
"provider": "kakao",
"code": "string"
}
์๋ต ํ๋ ๋ถ๋ถ์ @rlacksgus97๊ฐ ์ฐ๊ฒฐํด์ ์์ ํด์ฃผ์ธ์.
Response Body
{
"accessToken": "string",
"refreshToken": "string"
}
์ค๋ฌธ์ ์์ฑํ ๋๋ง๋ค ํด๋น ์ ์ ์ ํต๊ณ ํ ์ด๋ธ ์ ๋ฐ์ดํธํฉ๋๋ค.
{
"wikiId": "uuid",
// period์ relation ์ค ํ๋๋ง ์กด์ฌ
"filter_type": "PERIOD" or "RELATION",
"filter_value": "work",
"answers": [
{
"questionId": "uuid",
"total_count": 100,
"options": [ { "optionId": "option id", "legend": "string", "count": 10 }, ... ]
}
]
}
ํด๋นํ๋ ์ง๊ณ ์ ํ๋ง ์ ์ฒด ํต๊ณ๋ฅผ ๊ณ์ฐํ๋ค.
์ ์ฒด ํต๊ณ๋ ํ์ํ ๋์๋ณด๋ ๊ณ์ฐ ๊ธฐ๋ฅ ์ถ๊ฐํฉ๋๋ค.
JwtExceptionHandlerFilter๋ฅผ ๊ฑฐ์น๋ ๊ฒฝ์ฐ CORS ์ค์ ์ด ์ ์ฉ๋์ง ์์
๋น์จ ๊ณ์ฐ ๋์๋ณด๋ ์ปดํฌ๋ํธ totalCount๊ฐ ์ค์ ๋ฐ์ดํฐ์ ๋ง์ง ์์ต๋๋ค.
์ง์ ์ ๋ ฅ์ผ ๊ฒฝ์ฐ์๋ totalCount๋ ์ฆ๊ฐํด์ผ ํฉ๋๋ค.
JWT๋ฅผ ์ด์ฉํด ์ธ์ฆ์ ๊ตฌํํ๋ค.
์ธ์ฆ ํํฐ๋ฅผ ๊ฑฐ์น์ง ์๋ url์ ํน์ method๋ง ์ ์ฉ๋๋๋ก ์์ ์ด ํ์ํฉ๋๋ค.
POST
/surveyGET
/users์๋น์ค ํน์ฑ ์ question์ ๋ํ ์ ๋ณด๋ write๊ฐ ์ ๊ณ read๊ฐ ๋ง์ ์์
์
๊ธ๋ก๋ฒ ์บ์(๋ ๋์ค)๋ฅผ ๋์
ํ๊ธฐ์ ์ธํ๋ผ ์์์ด ๋ถ์กฑํ ์ํฉ
question์ ๋ํ ๋ก์ปฌ ์บ์๋ฅผ ์์ฑํด์ ์ฌ์ฉ
Map<String, Question>์ ํํ๋ก..?
Option์ order ํ๋ ์ถ๊ฐํฉ๋๋ค.
์ค๋ฌธ ์์ฑ ์, ๋น๋ฆด ์ ์๋ ์ต๋ ์ก์ ๊ฒ์ฆํฉ๋๋ค.
cors ๊ด๋ จ ์ค์ ์ ์ถ๊ฐํฉ๋๋ค.
๋ก๊ทธ์ธ ์ refresh token์ด DB์ ์ ์ฅ๋์ง ์์ต๋๋ค.
mongodb๋ rdb์ ๋ฌ๋ฆฌ dirty checking์ด ์์ต๋๋ค. ๊ณ ๋ก, setRefreshtoken ๋ฉ์๋ ํธ์ถ ํ save ๋ฉ์๋ ํธ์ถํด์ฃผ์ด์ผ ํฉ๋๋ค.
notification ๊ด๋ จ api ๊ตฌํํฉ๋๋ค.
GET
/notifications๋์ ์๋ฆผ ์กฐํ
PUT
/notifications/:notificationIdnotificationId
์ ํด๋นํ๋ ์๋์ ์ฝ์ ์ฒ๋ฆฌํ๋ค.
๋์๋ณด๋์ CHARACTER ํ์ ์์ questionId๋ฅผ ํฌํจํ๋๋ก ์์ ํฉ๋๋ค.
AS-IS
{
"dashboardType": "CHARACTER",
"questionId": "65d84728cfc30b23f358ca7c",
"friendly": true,
"similar": true,
"mbti": true,
"busy": false
},
TO-BE
{
"dashboardType": "CHARACTER",
"characters": [
{
"name": "FRIENDLINESS_LEVEL",
"value": true,
"questionId": "65d84728cfc30b23f358ca6f"
},
{
"name": "PERSONALITY_TYPE",
"value": true,
"questionId": "65d84728cfc30b23f358ca70"
},
{
"name": "MBTI_IMMERSION",
"value": true,
"questionId": "65d84728cfc30b23f358ca71"
},
{
"name": "WEEKEND_COMMITMENTS",
"value": false,
"questionId": "65d84728cfc30b23f358ca72"
}
]
}
์ค์จ๊ฑฐ์ ๋ ธ์ถ๋ ๋ฉํ๋ฐ์ดํฐ๋ฅผ ์์ฑํฉ๋๋ค.
swagger ์ค์ ์ผ๋ก API ๋ฌธ์๋ฅผ ๊ณต์ ํ ์ ์๋๋ก ํฉ๋๋ค.
๋ด๊ฐ ๋ฐ์ ์ค๋ฌธ ๋ชฉ๋ก ์กฐํ api ๊ตฌํ
GET
/surveysResponse
data : [
{
"surveyId": "asdf",
"relation": "ELEMENT",
"period": "period",
"senderName": "string"
},
...
]
application.yaml์ configmap์ ์ด์ฉํด pod์ ์ฃผ์ ํ ์ ์์ต๋๋ค.
์์ฑ ๋ฐฉ๋ฒ์ ์จ๋ผ์ธ์ผ๋ก ๊ณต์ ๋๋ฆฌ๊ฒ ์ต๋๋ค
๋ฌธํญ ์กฐํ api์ ๋ฌธํญ ํ์ ๋ณ ํํฐ ์ถ๊ฐํฉ๋๋ค.
QuestionType
์ ๋ฐ๋ฅธ ๋ฌธํญ ์กฐํํ ์ ์๋๋ก ์์ ํฉ๋๋ค.ํ์
OX
MULTIPLE_CHOICE
SHORT_ANSWER
NUMERIC_CHOICE
์ ์ ํ๋กํ ์์ API
OptionId๋ฅผ Question์ด ๊ฐ์ง๊ณ ์์ด์ ํญ์ Option์ ์กฐํํ๊ฒ ๋๋๋ฐ, RDB์ฒ๋ผ ์ฌ์ฉํ๊ณ ์๋ ๊ฒ ๊ฐ์ NoSql์ ํน์ง์ ๋ ์ด๋ฆฌ ์ํด์ ํ ์ปฌ๋ ์ ์์ ๊ด๋ฆฌํ๋ ๊ฒ์ด ๋ ์ฌ๋ฐ๋ฅด๋ค๋ ํ๋จ์ ๋๋ค.
Option Collection์ ์ญ์ ํ๊ณ , ๊ฐ Question์ด Option์ ๊ฐ์ง๊ณ ์๋ ๋ฐฉ์์ผ๋ก ๋ณ๊ฒฝํฉ๋๋ค.
Question ๋ณ๋ก ํต๊ณ๋ฅผ ๋ด๊ธฐ ๋๋ฌธ์ ๋ฐ๋ก ๊ด๋ฆฌํ ํ์ ์๋ค๊ณ ํ๋จํ์์ต๋๋ค.
SurveyAnswer์ SurveyAnswer.Answer๋ฅผ ์ ๊ฑฐํ๊ณ , ๋ก์ง์ Survey๋ก ์ด๋ํฉ๋๋ค.
unchecked exception์ ์ฒ๋ฆฌํ Global Handler๋ฅผ ์ ์ํฉ๋๋ค.
MULTI_CHOICE ์ผ ๋ ์ต์ ์ MANUAL ํ์ ์ถ๊ฐํฉ๋๋ค.
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.