Home

📖API Specification

baseURI: localhost:3000

서버 API

서버 주소 : :3000/ ~

회원가입[POST] ⚡

[POST] /user/signup

Request-Body (application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "회원 가입 성공.",
    "data": {
        "id": 2,
        "email": "[email protected]",
        "userName": "tester"
    }
}

FAIL 1 : 이미 등록된 ID일 경우

{
    "status": 400,
    "success": false,
    "message": "존재하는 ID 입니다."
}

FAIL 2 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 3 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "회원 가입 실패."
}

로그인[POST] ⚡

[POST] /user/signin

Request-Body (application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "로그인 성공.",
    "data": {
        "id": 2,
        "email": "[email protected]",
        "userName": "tester",
        "accessToken": "~~~"
    }
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 2 : 존재하지 않는 email

{
    "status": 400,
    "success": false,
    "message": "존재하지않는 유저 id 입니다."
}

FAIL 3 : 비밀번호 불일치

{
    "status": 400,
    "success": false,
    "message": "비밀번호가 일치하지 않습니다"
}

FAIL 4 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "로그인 실패."
}

토큰인증[Header] ⚡

로그인시 토큰값 헤더로 전송

FAIL 1 : 유효하지 않은 토큰

{
    "status": 401,
    "success": false,
    "message": "유효하지 않은 토큰값입니다."
}

FAIL 2 : 토큰 만료

{
    "status": 401,
    "success": false,
    "message": "토큰 값이 만료되었습니다."
}

Request-Header Routes

Request-header (application/json)

QuestionCard 작성[POST] ⚡

회고 질문 카드 작성 후 저장

[POST] /card/create

Request-Body (application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "카드 생성 성공",
    "data": {
        "id": 14,
        "number": 4,
        "question": "가장 힘들었던 문제 상황은 무엇이었나요? 구체적으로 어떤 상황이었나요?",
        "ActivityId": 6,
        "content": "답변 4입니다."
    }
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "카드 생성 실패"
}

QuestionCard 수정[PUT] ⚡

회고 질문 카드 수정

[PUT] /card/update

Request-Body (application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "카드 수정 성공",
    "data": "질문 카드 수정 완료"
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "카드 수정 실패"
}

QuestionCard 조회[GET] ⚡

작성한 회고 질문 카드 조회 (기본 질문 10개+ 유저가 작성한 회고 질문 카드들)

[GET] /card/:ActivityId

Request-Parameter (application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "카드 조회 성공",
    "data": {
        "questions": [
            {
                "number": 1,
                "content": "활동을 하게 된 이유는 무엇인가요?",
                "guide": "활동을 시작하게 된 계기와 상황에 대해 설명해주세요."
            },
            {
                "number": 2,
                "content": "활동을 시작할 당시의 목표는 무엇이었나요?",
                "guide": "개인적인 목표와 팀의 목표를 나눠서 생각해보면 좋아요."
            },
            {
                "number": 3,
                "content": "활동을 하며, 당신이 맡은 주요 역할과 그에 따른 과제는 무엇이었나요?",
                "guide": "해당 역할 및 과제를 맡게 된 배경을 함께 생각해보아요."
            },
            {
                "number": 4,
                "content": "가장 힘들었던 문제 상황은 무엇이었나요? 구체적으로 어떤 상황이었나요?",
                "guide": "예상치 못했던 위기 상황, 팀원과의 갈등 등 다양하게 생각해보면 좋아요."
            },
            {
                "number": 5,
                "content": "활동을 해결했던 과정을 순서대로 떠올려 볼까요?",
                "guide": "어떤 방법을 사용했는지 구체적으로 떠올려보세요."
            },
            {
                "number": 6,
                "content": "보다 효과적으로 수행하기 위해 어떤 노력을 했나요?",
                "guide": "조언을 구한 사람 혹은 참고한 자료를 떠올려보세요."
            },
            {
                "number": 7,
                "content": "해당 방법을 선택한 이유는 무엇인가요?",
                "guide": "다른 대안에 비해 가장 효과적이라고 생각했던 이유를 생각해보세요."
            },
            {
                "number": 8,
                "content": "이 활동에서 가장 크게 성취한 것은 무엇인가요?",
                "guide": "개인적인 성장과 대외적인 성과를 나눠서 생각해보면 좋아요."
            },
            {
                "number": 9,
                "content": "반면, 가장 아쉬운 것은 무엇인가요?",
                "guide": "어떤 부분을 개선하면 더 좋은 결과가 나왔을지 생각해보세요."
            },
            {
                "number": 10,
                "content": "활동을 통해 배운 점은 무엇인가요? 나의 관심 분야·직무에서 어떻게 도움이 될까요?",
                "guide": "관련 직무와 핵심 역량 해시태그를 떠올려 보세요."
            }
        ],
        "questionCards": [
            {
                "number": 1,
                "question": "활동을 하게 된 이유는 무엇인가요?",
                "content": "Answer 1"
            },
            {
                "number": 2,
                "question": "활동을 시작할 당시의 목표는 무엇이었나요?",
                "content": "Answer 2"
            },
            {
                "number": 3,
                "question": "활동을 하며, 당신이 맡은 주요 역할과 그에 따른 과제는 무엇이었나요?",
                "content": "Answer 3"
            },
            {
                "number": 4,
                "question": "가장 힘들었던 문제 상황은 무엇이었나요? 구체적으로 어떤 상황이었나요?",
                "content": "4번 답변 수정할게요!"
            }
        ]
    }
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우 → (이 경우 파라미터가 없으면 해당 라우팅이 없기 때문)

404 에러페이지

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "카드 조회 실패"
}

Question 조회[GET] ⚡

회고 질문 카드에 제공되는 기본 10개의 질문 조회

[GET] /question

Request-Body(application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "질문 가져오기 성공",
    "data": [
        {
            "number": 1,
            "content": "활동을 하게 된 이유는 무엇인가요?",
            "guide": "활동을 시작하게 된 계기와 상황에 대해 설명해주세요."
        },
        {
            "number": 2,
            "content": "활동을 시작할 당시의 목표는 무엇이었나요?",
            "guide": "개인적인 목표와 팀의 목표를 나눠서 생각해보면 좋아요."
        },
        {
            "number": 3,
            "content": "활동을 하며, 당신이 맡은 주요 역할과 그에 따른 과제는 무엇이었나요?",
            "guide": "해당 역할 및 과제를 맡게 된 배경을 함께 생각해보아요."
        },
        {
            "number": 4,
            "content": "가장 힘들었던 문제 상황은 무엇이었나요? 구체적으로 어떤 상황이었나요?",
            "guide": "예상치 못했던 위기 상황, 팀원과의 갈등 등 다양하게 생각해보면 좋아요."
        },
        {
            "number": 5,
            "content": "활동을 해결했던 과정을 순서대로 떠올려 볼까요?",
            "guide": "어떤 방법을 사용했는지 구체적으로 떠올려보세요."
        },
        {
            "number": 6,
            "content": "보다 효과적으로 수행하기 위해 어떤 노력을 했나요?",
            "guide": "조언을 구한 사람 혹은 참고한 자료를 떠올려보세요."
        },
        {
            "number": 7,
            "content": "해당 방법을 선택한 이유는 무엇인가요?",
            "guide": "다른 대안에 비해 가장 효과적이라고 생각했던 이유를 생각해보세요."
        },
        {
            "number": 8,
            "content": "이 활동에서 가장 크게 성취한 것은 무엇인가요?",
            "guide": "개인적인 성장과 대외적인 성과를 나눠서 생각해보면 좋아요."
        },
        {
            "number": 9,
            "content": "반면, 가장 아쉬운 것은 무엇인가요?",
            "guide": "어떤 부분을 개선하면 더 좋은 결과가 나왔을지 생각해보세요."
        },
        {
            "number": 10,
            "content": "활동을 통해 배운 점은 무엇인가요? 나의 관심 분야·직무에서 어떻게 도움이 될까요?",
            "guide": "관련 직무와 핵심 역량 해시태그를 떠올려 보세요."
        }
    ]
}

FAIL : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "질문 가져오기 실패"
}

선택한 활동 조회[GET] ⚡

사용자가 선택한 활동 조회 + 활동 작성 상태(회고 질문 카드 진행도)에 따라 QuestionCard 조회

[GET] /activity/getOneActivity/:ActivityId

Request-Parameter(application/json)

Response-body (application/json)

isFinished?

let isFinished;
/*

0: 작성한 활동카드 X

1: 작성한 활동카드가 있으나 10번까지 완성X

2: 10번까지 모든 활동카드 작성O

*/

SUCCESS 1 (isFinished = 0)

{
    "status": 200,
    "success": true,
    "message": "선택한 활동 가져오기 성공",
    "data": {
        "selectedActivity": {
            "id": 2,
            "title": "hacking",
            "startDate": "20210101",
            "endDate": "20210302",
            "group": "과기대",
            "summary": "",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609569981565.png",
            "fileName": "",
            "fileUrl": "",
            "star": false,
            "UserId": 1
        },
        "jobTag": [
            {
                "id": 5,
                "content": "개발자",
                "isJob": true,
                "ActivityId": 2
            },
            {
                "id": 6,
                "content": "서버 개발자",
                "isJob": true,
                "ActivityId": 2
            }
        ],
        "skillTag": [
            {
                "content": "Spring",
                "isJob": false
            },
            {
                "content": "Node.js",
                "isJob": false
            },
            {
                "content": "성적",
                "isJob": false
            }
        ],
        "isFinished": 0
    }
}

SUCCESS 2 (isFinished = 1)

{
    "status": 200,
    "success": true,
    "message": "선택한 활동 가져오기 성공",
    "data": {
        "selectedActivity": {
            "id": 6,
            "title": "잘되라",
            "startDate": "20201231",
            "endDate": "20211231",
            "group": "새해",
            "summary": "화이팅!",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609591991198.jpg",
            "fileName": "CheckHomeImg.png",
            "fileUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609591991257.png",
            "star": false,
            "UserId": 1
        },
        "jobTag": [
            {
                "id": 60,
                "content": "개발자",
                "isJob": true,
                "ActivityId": 6
            },
            {
                "id": 61,
                "content": "돈 많은 사람",
                "isJob": true,
                "ActivityId": 6
            }
        ],
        "skillTag": [
            {
                "content": "Spring",
                "isJob": false
            },
            {
                "content": "Docker",
                "isJob": false
            },
            {
                "content": "AWS",
                "isJob": false
            }
        ],
        "isFinished": 1
    }
}

SUCCESS 3 (isFinished = 2)

{
    "status": 200,
    "success": true,
    "message": "선택한 활동 가져오기 성공",
    "data": {
        "selectedActivity": {
            "id": 1,
            "title": "잘되라",
            "startDate": "20201231",
            "endDate": "20211231",
            "group": "새해",
            "summary": "화이팅!",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609592171400.jpg",
            "fileName": "CheckHomeImg.png",
            "fileUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609592171468.png",
            "star": false,
            "UserId": 1
        },
        "jobTag": [
            {
                "id": 75,
                "content": "개발자",
                "isJob": true,
                "ActivityId": 1
            },
            {
                "id": 76,
                "content": "돈 많은 사람",
                "isJob": true,
                "ActivityId": 1
            }
        ],
        "skillTag": [
            {
                "content": "Spring",
                "isJob": false
            },
            {
                "content": "Docker",
                "isJob": false
            },
            {
                "content": "AWS",
                "isJob": false
            }
        ],
        "isFinished": 2,
        "questionCards": [
            {
                "number": 1,
                "question": "활동을 하게 된 이유는 무엇인가요?",
                "content": "Answer 1"
            },
            {
                "number": 2,
                "question": "활동을 시작할 당시의 목표는 무엇이었나요?",
                "content": "Answer 2"
            },
            {
                "number": 3,
                "question": "활동을 하며, 당신이 맡은 주요 역할과 그에 따른 과제는 무엇이었나요?",
                "content": "Answer 3"
            },
            {
                "number": 4,
                "question": "가장 힘들었던 문제 상황은 무엇이었나요? 구체적으로 어떤 상황이었나요?",
                "content": "Answer 4이지롱"
            },
            {
                "number": 5,
                "question": "활동을 해결했던 과정을 순서대로 떠올려 볼까요?",
                "content": "Answer 5"
            },
            {
                "number": 6,
                "question": "보다 효과적으로 수행하기 위해 어떤 노력을 했나요?",
                "content": "Answer 6"
            },
            {
                "number": 7,
                "question": "해당 방법을 선택한 이유는 무엇인가요?",
                "content": "Answer 7"
            },
            {
                "number": 8,
                "question": "이 활동에서 가장 크게 성취한 것은 무엇인가요?",
                "content": "Answer 8"
            },
            {
                "number": 9,
                "question": "반면, 가장 아쉬운 것은 무엇인가요?",
                "content": "Answer 9"
            },
            {
                "number": 10,
                "question": "활동을 통해 배운 점은 무엇인가요? 나의 관심 분야·직무에서 어떻게 도움이 될까요?",
                "content": "Answer 10"
            }
        ]
    }
}

FAIL 1 : 존재하지 않는 활동

{
    "status": 400,
    "success": false,
    "message": "선택한 활동 가져오기 실패"
}

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "선택한 활동 가져오기 실패"
}

전체 활동 조회[GET] ⚡

사용자가 작성한 모든 활동 조회

[GET] /activity/getAllActivity

Request-Body(application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "전체 활동 가져오기 성공",
    "data": [
        {
            "id": 1,
            "title": "잘되라",
            "startDate": "20201231",
            "endDate": "20211231",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609592171400.jpg",
            "jobTag": [
                "개발자",
                "돈 많은 사람"
            ],
            "skillTag": [
                "Spring",
                "Docker",
                "AWS"
            ]
        },
        {
            "id": 2,
            "title": "hacking",
            "startDate": "20210101",
            "endDate": "20210302",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609569981565.png",
            "jobTag": [
                "개발자",
                "서버 개발자"
            ],
            "skillTag": [
                "Spring",
                "Node.js",
                "성적"
            ]
        },
        {
            "id": 3,
            "title": "three",
            "startDate": "20180917",
            "endDate": "20200552",
            "imageUrl": "",
            "jobTag": [
                "개발자",
                "서버 개발자"
            ],
            "skillTag": [
                "Spring",
                "Node.js",
                "성적"
            ]
        },
        {
            "id": 4,
            "title": "실험",
            "startDate": "20210101",
            "endDate": "20210202",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609583282664.png",
            "jobTag": [
                "개발자",
                "서버 개발자"
            ],
            "skillTag": [
                "Spring",
                "Node.js",
                "성적"
            ]
        },
        {
            "id": 5,
            "title": "실험체",
            "startDate": "20210101",
            "endDate": "20210202",
            "imageUrl": "",
            "jobTag": [
                "개발자",
                "서버 개발자"
            ],
            "skillTag": [
                "Spring",
                "Node.js",
                "성적"
            ]
        },
        {
            "id": 6,
            "title": "잘되라",
            "startDate": "20201231",
            "endDate": "20211231",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609591991198.jpg",
            "jobTag": [
                "개발자",
                "돈 많은 사람"
            ],
            "skillTag": [
                "Spring",
                "Docker",
                "AWS"
            ]
        }
    ]
}

FAIL : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "전체활동 가져오기 실패"
}

즐겨찾기 활동 조회[GET] ⚡

사용자가 즐겨찾기한 모든 활동 조회

[GET] /activity/getLikeActivity

Request-Body(application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "전체 즐겨찾기 가져오기 성공",
    "data": [
        {
            "id": 1,
            "title": "잘되라",
            "startDate": "20201231",
            "endDate": "20211231",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609592171400.jpg",
            "jobTag": [
                "개발자",
                "돈 많은 사람"
            ],
            "skillTag": [
                "Spring",
                "Docker",
                "AWS"
            ]
        },
        {
            "id": 3,
            "title": "three",
            "startDate": "20180917",
            "endDate": "20200502",
            "imageUrl": "",
            "jobTag": [
                "개발자",
                "서버 개발자"
            ],
            "skillTag": [
                "Spring",
                "Node.js",
                "성적"
            ]
        }
    ]
}

FAIL : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "전체 즐겨찾기 가져오기 실패"
}

즐겨찾기 추가 및 해제[PUT] ⚡

즐겨찾기 추가 및 해제(즐겨찾기 O → X , X → O)

[PUT] activity/likeActivity/:ActivityId

Request-Parameter(application/json)

Response-body (application/json)

SUCCESS 1: 즐겨찾기 추가

{
    "status": 200,
    "success": true,
    "message": "즐겨찾기 추가 및 해제 성공",
    "data": "즐겨찾기 추가"
}

SUCCESS 2: 즐겨찾기 해제

{
    "status": 200,
    "success": true,
    "message": "즐겨찾기 추가 및 해제 성공",
    "data": "즐겨찾기 해제"
}

FAIL : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "즐겨찾기 추가/해제 실패"
}

해쉬태그 목록 조회[GET] ⚡

유저가 사용한 해쉬태그 목록 조회

[GET] /hashtag

Request-Body(application/json)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "해시태그 조회 성공",
    "data": {
        "jobTag": [
            "개발자",
            "서버 개발자",
            "돈 많은 사람"
        ],
        "skillTag": [
            "Spring",
            "Node.js",
            "성적",
            "Docker",
            "AWS"
        ]
    }
}

FAIL : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "해시태그 조회 실패"
}

활동 생성[POST] ⚡

사용자가 자신의 활동을 생성

[POST] /activity/create

Request-Body(form-data)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "활동 생성 성공",
    "data": {
        "newActivity": {
            "id": 7,
            "title": "테스트 활동",
            "startDate": "20190101",
            "endDate": "20200420",
            "group": "Something",
            "summary": "",
            "imageUrl": "https://sopt-27-osj.s3.ap-northeast-2.amazonaws.com/images/origin/1609739675912.png",
            "fileUrl": "",
            "fileName": "",
            "star": false,
            "UserId": 2
        },
        "newHashtag": [
            {
                "id": 80,
                "content": "개발자",
                "isJob": true,
                "ActivityId": 7
            },
            {
                "id": 81,
                "content": "서버 개발자",
                "isJob": true,
                "ActivityId": 7
            },
            {
                "id": 82,
                "content": "개발",
                "isJob": false,
                "ActivityId": 7
            },
            {
                "id": 83,
                "content": "Node.js",
                "isJob": false,
                "ActivityId": 7
            },
            {
                "id": 84,
                "content": "성적",
                "isJob": false,
                "ActivityId": 7
            }
        ]
    }
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "활동 생성 실패"
}

활동 수정[PUT] ⚡

사용자가 활동을 전체적으로 수정

[PUT] activity/update

Request-Body(form-data)

Response-body (application/json)

SUCCESS

{
    "status": 200,
    "success": true,
    "message": "활동 정보 수정 성공",
    "data": "활동 정보 수정 완료"
}

FAIL 1 : 필수 입력값이 미입력 상태일 경우

{
    "status": 400,
    "success": false,
    "message": "필요한 값이 없습니다."
}

FAIL 2 : 서버 에러

{
    "status": 500,
    "success": false,
    "message": "활동 정보 수정 실패"
}

Home

📖API Specification

baseURI: localhost:3000

서버 API

서버 주소 : :3000/ ~

[POST] /user/signup

Response-body (application/json)

[POST] /user/signin

Response-body (application/json)

회고 질문 카드 작성 후 저장

[POST] /card/create

Response-body (application/json)

회고 질문 카드 수정

[PUT] /card/update

Response-body (application/json)

작성한 회고 질문 카드 조회 (기본 질문 10개+ 유저가 작성한 회고 질문 카드들)

[GET] /card/:ActivityId

Response-body (application/json)

회고 질문 카드에 제공되는 기본 10개의 질문 조회

[GET] /question

Response-body (application/json)

사용자가 선택한 활동 조회 + 활동 작성 상태(회고 질문 카드 진행도)에 따라 QuestionCard 조회

[GET] /activity/getOneActivity/:ActivityId

Response-body (application/json)

사용자가 작성한 모든 활동 조회

[GET] /activity/getAllActivity

Response-body (application/json)

사용자가 즐겨찾기한 모든 활동 조회

[GET] /activity/getLikeActivity

Response-body (application/json)

즐겨찾기 추가 및 해제(즐겨찾기 O → X , X → O)

[PUT] activity/likeActivity/:ActivityId

Response-body (application/json)

유저가 사용한 해쉬태그 목록 조회

[GET] /hashtag

Response-body (application/json)

사용자가 자신의 활동을 생성

[POST] /activity/create

Response-body (application/json)

사용자가 활동을 전체적으로 수정

[PUT] activity/update

Response-body (application/json)

Clone this wiki locally