Skip to content
songz1 edited this page Jan 11, 2019 · 11 revisions

Group

그룹 생성

메소드 경로 설명
POST /groups 그룹 생성

요청헤더

Authorization: token

응답 바디

그룹 생성 성공

{
    "status": 201,
    "message": "그룹 생성 성공",
    "data": {
        "groupIdx": 6,
        "groupId": "d59a8bbd01fb4410ad8b12f37a3e91ab"
    }
}
Parameters
필드 타입 필수여부 설명
groupIdx Int Required 그룹 고유 번호
groupId String Required 그룹 아이디

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

이미 가입된 그룹이 있는 회원의 접근

{
    "status": 204,
    "message": "이미 가입된 그룹이 있습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

그룹 참여

메소드 경로 설명
POST /groups/join 그룹 참여

요청헤더

Authorization: token
Content-Type :application/json

요청 바디

{
    "code": "4587e8d4389c"
}
Parameters
필드 타입 필수여부 설명
code String Required 초대 코드

응답 바디

그룹 참여 성공

{
    "status": 200,
    "message": "그룹 참여 성공",
    "data": {
        "groupIdx": 6,
        "groupId": "d59a8bbd01fb4410ad8b12f37a3e91ab"
    }
}
Parameters
필드 타입 필수여부 설명
groupIdx Int Required 그룹 고유 번호
groupId String Required 그룹 아이디

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

이미 가입된 그룹이 있는 회원의 접근

{
    "status": 204,
    "message": "이미 가입된 그룹이 있습니다.",
    "data": null
}

유효하지 않은 초대코드

{
    "status": 401,
    "message": "초대코드가 유효하지 않습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

그룹 수정

메소드 경로 설명
PUT /groups 그룹 수정

요청헤더

Authorization: token
Content-Type : multipart/form-data

요청 바디

{
    "homePhoto": file
}
Parameters
필드 타입 필수여부 설명
homePhoto File Optional 그룹 배경 사진, Default : null

응답 바디

그룹 수정 성공

{
    "status": 200,
    "message": "그룹 수정 성공",
    "data": null
}

존재하지 않는 그룹

{
    "status": 404,
    "message": "그룹을 찾을 수 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

그룹 탈퇴

메소드 경로 설명
DELETE /groups/withdraw 그룹 탈퇴

요청헤더

Authorization: token

응답 바디

그룹 탈퇴 성공

{
    "status": 200,
    "message": "그룹 탈퇴 성공",
    "data": null
}

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

가입된 그룹이 없는 회원의 접근

{
    "status": 204,
    "message": "참여된 그룹이 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}

그룹 초대 코드 생성/조회

메소드 경로 설명
GET /groups/invitation 그룹 초대 코드 생성/조회

요청헤더

Authorization: token

응답 바디

그룹 초대 코드 조회 성공

  • 초대 코드 만료시간은 10분
{
    "status": 200,
    "message": "초대코드 조회 성공",
    "data": {
        "code": "7b06f058fb55",
        "groupIdx": 2,
        "createdAt": "2019-01-04T17:32:17.598",
        "expiredAt": "2019-01-04T17:42:17.598"
    }
}
Parameters
필드 타입 필수여부 설명
code String Required 그룹 초대코드
groupIdx int Required 그룹 고유 번호
createdAt LocalDateTime Required 초대코드 생성 시간
expiredAt LocalDateTime Required 초대코드 만료 시간

유효하지 않은 회원의 접근

{
    "status": 404,
    "message": "회원을 찾을 수 없습니다.",
    "data": null
}

가입된 그룹이 없는 회원의 접근

{
    "status": 204,
    "message": "참여된 그룹이 없습니다.",
    "data": null
}

DB 에러

{
    "status": 600,
    "message": "데이터베이스 에러",
    "data": null
}

INTERNAL SERVER ERROR

{
    "status": 500,
    "message": "서버 내부 에러",
    "data": null
}