옷달 (옷장 달력) REST API

`/member`

Member 접기 / 펼치기

1. `/siginin` (POST)

아이디와 비밀번호를 통해 인증 토큰 발급

/sigin (POST) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/signin`
Header	`accept: application/json`
Body	`{ "email": "swj@gmail.com", "password": "1234321swj" }`
Method	POST

Parameter	Description	Required
email	이메일	필수
password	비밀번호	필수

Response

Status Code	Description
200 OK	요청이 성공적으로 완료됨.
401 UnAuthorized	아이디 또는 비밀번호가 올바르지 않음.
404 Not Found	요청된 자원이 존재하지 않음.

eyJhbGciOiJIUzI1NiJ9.eyJzdWIiOiJ3b25qdUBuYXZlci5jb20iLCJyb2xlIjoiVVNFUiIsImlhdCI6MTYwOTQxOTU0NSwiZXhwIjoxNjA5NDIzMTQ1fQ.OWidIHqUdGqxOy6hjgowE5BXNcNOQ5JEQUU5yt9zolA (Token_Value)

2. `/email` (POST)

중복된 이메일인지 확인

/email (POST) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/email`
Header	`accept: application/json`
Body	`{ "email": "swj@gmail.com" }`
Method	POST

Parameter	Description	Required
email	이메일	Yes

Response

Status Code	Description
204 No Content	중복되지 않은 이메일임.
400 Bad Request	중복된 이메일임.
404 Not Found	요청된 자원이 존재하지 않음.

3. `/join` (POST)

회원정보를 입력하여 회원가입

/join (POST) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/join`
Header	`accept: application/json`
Body	`{ "email": "swj@gmail.com", "password": "1234321swj", "name": "Son", "age": "10", "gender": "MALE", "birthday": "2021-01-01", "nickname": "수박바" }`
Method	POST

Parameter	Description	Required
email	이메일	Yes
password	비밀번호	Yes
name	이름	No
age	나이	No
gender	성별 (MALE, FEMALE)	No
birthday	생년월일	No
nickname	닉네임	No
role	권한	NO

Response

Status Code	Description
201 Created	회원 정보가 성공적으로 생성됨.
404 Not Found	요청된 자원이 존재하지 않음.

4. `/list` (GET)

모든 회원의 정보를 조회

/list (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/list`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Response

Status Code	Description
200 OK	회원 정보를 성공적으로 조회함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": [
        {
            "email": "swj@gmail.com",
            "password": "1234321swj",
            "name": "Son",
            "age": "10",
            "gender": "MALE",
            "birthday": "2021-01-01",
            "nickname": "수박바"
        },
        {
            "email": "tttt@naver.com",
            "password": "4543342@ddd"
            "name": "Kim",
            "age": 44,
            "gender": "FEMALE",
            "birthday": "1985-01-20",
            "nickname": "바밤바"
        }
    ],
    "entityClassName": "Member",
    "msg": "모든 회원 조회에 성공하였습니다.",
    "success": true
}

5. `/{id}` (GET)

id에 해당하는 회원 정보 한 건을 조회

/{id} (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/{id}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
200 OK	회원 정보를 성공적으로 조회함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": {
        "email": "swj@gmail.com",
        "password": "1234321swj",
        "name": "Son",
        "age": "10",
        "gender": "MALE",
        "birthday": "2021-01-01",
        "nickname": "수박바"
    },
    "entityClassName": "Member",
    "msg": "ID [1] 회원 정보 조회에 성공하였습니다.",
    "success": true
}

6. `/{id}` (PUT)

id에 해당하는 회원 정보를 갱신 (이메일은 변경 불가)

/{id} (PUT) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/join`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	`{ "name": "Son", "age": "22", "gender": "MALE", "birthday": "1990-10-01", "nickname": "스크류바" }`
Method	PUT

Parameter	Description	Required
name	이름	No
age	나이	No
gender	성별 (MALE, FEMALE)	No
birthday	생년월일	No
nickname	닉네임	No

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
200 OK	회원 정보를 성공적으로 갱신함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

7. `/{id}` (PATCH)

id에 해당하는 회원 비밀번호를 갱신

/{id} (PATCH) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/{id}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	`{ "password": "dwnnsjdxdf" }`
Method	PATCH

Parameter	Description	Required
password	비밀번호	Yes

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
200 OK	회원 정보를 성공적으로 갱신함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

8. `/{id}` (DELETE)

id에 해당하는 회원 정보를 삭제

/{id} (DELETE) 접기 / 펼치기

Request

Request Component	Value
Name	`/list`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	DELETE

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
204 No Content	회원 정보를 성공적으로 삭제함. (옷장, 옷도 같이 삭제)
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

`/closet`

Closet 접기 / 펼치기

1. `/{memberId}` (POST)

옷장 정보를 입력하여 옷장 생성

/{memberId} (POST) 접기 / 펼치기

Request

Body Parameter

Request Component	Value
Name	`/{memberId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	`{ "closetName": "member1 closet1" }`
Method	POST

Parameter	Description	Required
closetName	옷장 이름	Yes

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
201 Created	옷장 정보가 성공적으로 생성됨.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

2. `/{closetId}` (GET)

id에 해당하는 옷장 정보와 옷장에 들어있는 옷들 조회

/{closetId} (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/{closetId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Query Parameters

Parameter	Description	Required
`id`	Closet ID (PK)	Yes

Response

Status Code	Description
200 OK	옷장 정보가 성공적으로 조회됨.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": {
        "closetName": "멤버1의 1번 옷장",
        "clothesList": [
            {
                "name": "겨울옷",
                "brand": "나이키",
                "clothes_type": "상의",
                "color": "검은색"
            },
            {
                "name": "겨울옷",
                "brand": "나이키",
                "clothes_type": "하의",
                "color": "빨간색"
            }
        ]
    },
    "entityClassName": "Closet",
    "msg": "ID [1] 옷장 정보 조회에 성공하였습니다.",
    "success": true
}

3. `/list/{memberId}` (GET)

id에 해당하는 회원의 모든 옷장 정보와 옷장에 들어있는 옷들 조회

/list/{memberId} (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/list/{memberId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Query Parameters

Parameter	Description	Required
`id`	Member ID (PK, Not Email)	Yes

Response

Status Code	Description
200 OK	멤버의 모든 옷장 정보가 성공적으로 조회됨.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": [
        {
            "closetName": "멤버1의 1번 옷장",
            "clothesList": [
                {
                    "name": "겨울옷",
                    "brand": "나이키",
                    "clothes_type": "상의",
                    "color": "검은색"
                },
                {
                    "name": "겨울옷",
                    "brand": "나이키",
                    "clothes_type": "하의",
                    "color": "빨간색"
                }
            ]
        },
        {
            "closetName": "멤버1의 2번 옷장",
            "clothesList": [
                {
                    "name": "가을",
                    "brand": "아디다스",
                    "clothes_type": "츄리닝",
                    "color": "회색"
                }
            ]
        }
    ],
    "entityClassName": "Closet",
    "msg": "멤버 [1]의 모든 옷장 조회에 성공하였습니다.",
    "success": true
}

4. `/{closetId}` (DELETE)

id에 해당하는 옷장 정보를 삭제

/{closetId} (DELETE) 접기 / 펼치기

Request

Request Component	Value
Name	`/{closetId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	DELETE

Query Parameters

Parameter	Description	Required
`closetId`	Closet ID (PK)	Yes

Response

Status Code	Description
204 No Content	옷장 정보를 성공적으로 삭제함. (옷도 같이 삭제)
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

`/clothes`

Clothes 접기 / 펼치기

1. `/{clothesId}` (GET)

id에 해당하는 옷 정보 한 건을 조회

/{clothesId} (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/{clothesId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Query Parameters

Parameter	Description	Required
`clothesId`	Clothes ID (PK)	Yes

Response

Status Code	Description
200 OK	옷 정보를 성공적으로 조회함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": {
        "id": 1,
        "name": "겨울옷",
        "brand": "나이키",
        "clothes_type": "상의",
        "color": "검은색"
    },
    "entityClassName": "Clothes",
    "msg": "ID [1] 옷 조회에 성공하였습니다.",
    "success": true
}

2. `/list` (GET)

모든 옷 정보 조회

/list (GET) 접기 / 펼치기

Request

Request Component	Value
Name	`/list`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Response

Status Code	Description
200 OK	옷 정보를 성공적으로 조회함.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

{
    "data": [
        {
            "id": 1,
            "name": "겨울옷",
            "brand": "나이키",
            "clothes_type": "상의",
            "color": "검은색"
        },
        {
            "id": 2,
            "name": "겨울옷",
            "brand": "나이키",
            "clothes_type": "하의",
            "color": "빨간색"
        },
        {
            "id": 3,
            "name": "가을",
            "brand": "아디다스",
            "clothes_type": "츄리닝",
            "color": "회색"
        }
    ],
    "entityClassName": "Clothes",
    "msg": "모든 옷 조회에 성공하였습니다.",
    "success": true
}

3. `/{clothesId}` (DELETE)

id에 해당하는 옷 정보 삭제

/{clothesId} (DELETE) 접기 / 펼치기

Request

Request Component	Value
Name	`/{clothesId}`
Header	`accept: application/json` `Bearer Token: TOKEN_VALUE`
Body	N/A
Method	GET

Query Parameters

Parameter	Description	Required
`clothesId`	Clothes ID (PK)	Yes

Response

Status Code	Description
204 No Content	옷 정보를 성공적으로 삭제함.
400 Bad Request	요청한 회원 정보가 존재하지 않음.
401 UnAuthorized	해당 리소스에 접근하기 위한 권한이 없음. (토큰 필요)

Name		Name	Last commit message	Last commit date
Latest commit History 30 Commits
gradle/wrapper		gradle/wrapper
src		src
.gitignore		.gitignore
README.md		README.md
build.gradle		build.gradle
gradlew		gradlew
gradlew.bat		gradlew.bat
settings.gradle		settings.gradle

Folders and files

Latest commit

History

Repository files navigation

옷달 (옷장 달력) REST API

/member

1. /siginin (POST)

Request

Body Parameter

Response

2. /email (POST)

Request

Body Parameter

Response

3. /join (POST)

Request

Body Parameter

Response

4. /list (GET)

Request

Response

5. /{id} (GET)

Request

Query Parameters

Response

6. /{id} (PUT)

Request

Body Parameter

Query Parameters

Response

7. /{id} (PATCH)

Request

Body Parameter

Query Parameters

Response

8. /{id} (DELETE)

Request

Query Parameters

Response

/closet

1. /{memberId} (POST)

Request

Body Parameter

Query Parameters

Response

2. /{closetId} (GET)

Request

Query Parameters

Response

3. /list/{memberId} (GET)

Request

Query Parameters

Response

4. /{closetId} (DELETE)

Request

Query Parameters

Response

/clothes

1. /{clothesId} (GET)

Request

Query Parameters

Response

2. /list (GET)

Request

Response

3. /{clothesId} (DELETE)

Request

Query Parameters

Response

About

Topics

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

`/member`

1. `/siginin` (POST)

2. `/email` (POST)

3. `/join` (POST)

4. `/list` (GET)

5. `/{id}` (GET)

6. `/{id}` (PUT)

7. `/{id}` (PATCH)

8. `/{id}` (DELETE)

`/closet`

1. `/{memberId}` (POST)

2. `/{closetId}` (GET)

3. `/list/{memberId}` (GET)

4. `/{closetId}` (DELETE)

`/clothes`

1. `/{clothesId}` (GET)

2. `/list` (GET)

3. `/{clothesId}` (DELETE)

Packages