dnd-side-project / dnd-10th-6-backend Goto Github PK

기능 설명

• 로그인
• 회원가입

요구 사항

• 카카오 로그인을 시도하면,
• DB에 존재하는 사용자인지 확인 후
• 회원가입/로그인을 진행하고 accessToken, refreshToken을 반환한다.
• refreshToken은 DB에 저장된다.

특이 사항

기능 설명

내가 작성한 설문 조회 API 구현합니다.

요구 사항

GET /users/profile/surveys?pageSize&pageNo&period&relation

• period, relation 필터 적용
• pagination 적용

Response

{
	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 도메인으로 이동합니다.

요구 사항

• Statistics와 Statistic을 Dashboard 도메인으로 이동합니다.
• 전체통계량 계산하는 것과 유저 통계량 계산하는 로직을 분리합니다.

특이 사항

버그 현상

재현 방법

예상했던 동작

스크린샷

특이 사항

기능 설명

유저 프로필 조회 api

요구 사항

특이 사항

기능 설명

db의 전체 컬렉션이 updatedAt, createdAt 필드 추가

요구 사항

특이 사항

기능 설명

요구 사항

특이 사항

기능 설명

Question에 reason required 필드 추가합니다.

요구 사항

• short_answer일 경우 이유 입력이 필수가 아니므로, Question에 reason required 필드를 추가합니다.
• 문항 조회 시 reasonRequired 필드 함께 응답합니다.
• 설문 생성 시
  • reason required인데, reason 필드가 비어있을 경우 예외 발생합니다.

기능 설명

질문별 상세보기

요구 사항

특이 사항

• projection 없이 구현 이후 리팩토링

기능 설명

전체 문항을 조회할 수 있다.

요구 사항

• 인증 없이 조회가능해야 함
• 문항 데이터 넣는 ddl도 함께 작성
• question과 option 테이블 생성

/**** 문항(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"
}

특이 사항

기능 설명

내가 아닌 다른 사람이 나의 설문을 생성할 수 있다.

요구 사항

• 인증은 Optional하다.
  • 인증된 요청일 경우 -> 요청한 사용자의 정보를 함께 저장한다.
  • 익명일 경우 -> null로 비워둔다.

/**** 설문(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"
}

Enum

Period

• SIX_MONTHS
• ONE_YEAR
• FOUR_YEARS
• INFINITE

Relation

• ELEMENTARY_SCHOOL
• MIDDLE_AND_HIGH_SCHOOL
• UNIVERSITY
• WORK
• SOCIAL
• ETC

특이 사항

버그 현상

재현 방법

예상했던 동작

스크린샷

특이 사항

기능 설명

• 스테이징 CI/CD 설정합니다
• main과 staging 브랜치가 푸시되었을 때 각각 운영, 스테이징 환경에 자동 배포합니다

요구 사항

특이 사항

버그 현상

question 순서가 보장되지 않아 pair question answer에서 오류발생

재현 방법

예상했던 동작

스크린샷

특이 사항

기능 설명

익명 필드가 제거됨에 따라, request에서 isAnonymous 필드를 제거합니다.

기능 설명

유저 퍼블릭 정보 조회 api 구현합니다.

요구 사항

• 인증 필요하지 않습니다.
• wikiId를 쿼리스트링으로 받고, nickname을 응답합니다.

특이 사항

기능 설명

요구 사항

특이 사항

기능 설명

빌릴 수 있는 금액 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"
}

특이 사항

기능 설명

설문을 생성할 때마다 해당 유저의 통계 테이블 업데이트합니다.

요구 사항

• 설문 생성 api가 호출되고, 정상적인 요청이라면 해당 유저의 통계 테이블을 업데이트한다.
• 질문마다 통계 유형 필드를 가지고 있다.
• 집계 유형 : 대시보드 유형마다 집계 유형을 가지고 있다.
  • RATIO
  • AVERAGE
• 대시보드 유형 : 질문마다 대시보드 유형을 가지고 있다.
  • BEST_WORTH
  • CHARACTER
  • MONEY
  • HAPPY
  • SAD

유저 별 통계

{
    "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 }, ... ]
        }
    ]
}

전체 통계

해당하는 집계 유형만 전체 통계를 계산한다.

• 집계 유형
  • AVERAGE

특이 사항

기능 설명

전체 통계량 필요한 대시보드 계산 기능 추가합니다.

요구 사항

• Period, Relation 별로 전체 통계량 계산
  • MONEY 대시보드 타입
• Dashboard 조회 api 응답에 해당 값 설정

특이 사항

버그 현상

JwtExceptionHandlerFilter를 거치는 경우 CORS 설정이 적용되지 않음

재현 방법

예상했던 동작

스크린샷

특이 사항

버그 현상

비율 계산 대시보드 컴포넌트 totalCount가 실제 데이터와 맞지 않습니다.

예상했던 동작

직접입력일 경우에도 totalCount는 증가해야 합니다.

기능 설명

JWT를 이용해 인증을 구현한다.

요구 사항

• 로그인 시, accessToken과 refreshToken을 발급한다.
• accessToken과 refreshToken을 이용해 사용자를 인증한다.

특이 사항

기능 설명

인증 필터를 거치지 않는 url에 특정 method만 적용되도록 수정이 필요합니다.

요구 사항

• /survey -> POST /survey
• /users -> GET /users

특이 사항

기능 설명

서비스 특성 상 question에 대한 정보는 write가 적고 read가 많은 작업임
글로벌 캐시(레디스)를 도입하기엔 인프라 자원이 부족한 상황
question에 대한 로컬 캐시를 생성해서 사용
Map<String, Question>의 형태로..?

요구 사항

특이 사항

기능 설명

Option에 order 필드 추가합니다.

요구 사항

• Option Entity에 order 필드 추가
• 문항 조회 시 Option order 기준 정렬된 상태로 응답

기능 설명

설문 생성 시, 빌릴 수 있는 최대 액수 검증합니다.

요구 사항

• 설문 생성 시 BORROWING_LIMIT 문항의 MANUAL 답변 타입의 최댓값은 1,000,000,000원(10억)입니다.

기능 설명

cors 관련 설정을 추가합니다.

요구 사항

• origin은 localhost와 namui-wiki.life 만 허용합니다.
• method는 get, post, put, patch, delete 허용합니다.

특이 사항

버그 현상

로그인 시 refresh token이 DB에 저장되지 않습니다.

재현 방법

예상했던 동작

스크린샷

특이 사항

mongodb는 rdb와 달리 dirty checking이 없습니다. 고로, setRefreshtoken 메소드 호출 후 save 메소드 호출해주어야 합니다.

기능 설명

사용자별 대시보드 조회 API 구현

요구 사항

• 인증되고 회원가입된 사용자만 호출 가능
• dashboard 테이블에 있는 데이터를 가져와 정제 후 응답

특이 사항

기능 설명

notification 관련 api 구현합니다.

요구 사항

• 설문 생성 시 나의 알림 리스트에 해당 사항을 저장한다.

GET /notifications

나의 알림 조회

PUT /notifications/:notificationId

notificationId에 해당하는 알람을 읽음 처리한다.

기능 설명

대시보드의 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"
                    }
                ]
            }

특이 사항

기능 설명

• filter에서의 에러 핸들링
• 필터 이후 토큰 정보 활용
• refresh 구현

요구 사항

특이 사항

• #6 코드 리뷰에 대한 수정도 여기서 같이 진행하겠습니다.

기능 설명

요구 사항

특이 사항

기능 설명

스웨거에 노출될 메타데이터를 작성합니다.

기능 설명

요구 사항

swagger 설정으로 API 문서를 공유할 수 있도록 합니다.

특이 사항

기능 설명

내가 받은 설문 목록 조회 api 구현

요구 사항

GET /surveys

Response

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 별로 통계를 내기 때문에 따로 관리할 필요 없다고 판단하였습니다.

요구 사항

• 대시보드와 질문 조회 등 관련 api 수정 필요

특이 사항

기능 설명

SurveyAnswer와 SurveyAnswer.Answer를 제거하고, 로직을 Survey로 이동합니다.

요구 사항

• SurveyAnswer를 Survey로, SurveyAnswer.Answer를 Survey.Answer로 이동합니다.
• 이에 맞춰 테스트코드를 다시 작성합니다.

특이 사항

기능 설명

unchecked exception을 처리할 Global Handler를 정의합니다.

요구 사항

• ApplicationException 타입 정의
• RuntimeException을 상속받는 ApplicationErrorException 클래스 정의
• 전역 Exception 핸들러 정의

특이 사항

기능 설명

MULTI_CHOICE 일 때 옵션에 MANUAL 타입 추가합니다.

요구 사항

• 문항 조회 시 옵션에 MANUAL을 추가합니다.
• 설문 생성 시에는 기존 정책 유지합니다.

특이 사항