name	method	url
꿈 목록 조회	`GET`	/dreams
지난 꿈 목록 조회	`GET`	/dreams/history
단일 꿈 조회	`GET`	/dreams/{dreamId}
꿈 추가	`POST`	/dreams
꿈 수정	`PUT`	/dreams/{dreamId}
꿈 삭제	`DELETE`	/dreams/{dreamId}
꿈 결과 추가	`POST`	/dreams/{dreamId}/results
꿈 결과 수정	`PATCH`	/dreams/{dreamId}/results

꿈 목록 조회

name	method	url	description
꿈 목록 조회	`GET`	/dreams	요청한 유저 자신의 모든 꿈 목록을 조회(진행중인 것)

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Response

Body

Name	Data Type	Number	Description
dreams	Dream	`N`	꿈에 대한 정보

{
    "dreams": [
        {
            "user": {
                "nickname": "test",
                "email": "[email protected]"
            },
            "id": 2,
            "title": "second test",
            "description": "hello, this is test description",
            "start_at": "2019-12-22",
            "complete_by": "2020-12-22",
            "tag": 1,
            "created_at": "2019-12-29T01:39:50.308594+09:00",
            "updated_at": "2019-12-29T01:40:16.151289+09:00",
            "is_completed": false
        },
        {
            "user": {
                "nickname": "test",
                "email": "[email protected]"
            },
            "id": 1,
            "title": "first test",
            "description": "hello, this is test description",
            "start_at": "2019-12-22",
            "complete_by": "2020-12-22",
            "tag": 0,
            "created_at": "2019-12-29T01:38:43.972922+09:00",
            "updated_at": "2019-12-29T01:38:43.973211+09:00",
            "is_completed": false
        }
    ]
}

지난 꿈 목록 조회

name	method	url	description
지난 꿈 목록 조회	`GET`	/dreams/history	요청한 유저 자신의 지난 모든 꿈 목록을 조회

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Response

Body

Name	Data Type	Number	Description
dreams	Dream	`N`	꿈에 대한 정보

{
    "dreams": [
        {
            "user": {
                "nickname": "test",
                "email": "[email protected]"
            },
            "id": 2,
            "title": "DREAM2 TITLE CHANG?E",
            "description": "hello, this is test description",
            "start_at": "2019-12-22",
            "complete_by": "2020-12-22",
            "tag": 1,
            "created_at": "2019-12-29T01:39:50.308594+09:00",
            "updated_at": "2019-12-29T01:40:16.151289+09:00",
            "is_completed": true
        }
    ]
}

단일 꿈 조회

name	method	url	description
단일 꿈 조회	`GET`	/dreams/{dreamId}	단일 꿈에 대한 상세정보 조회

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Response

Body

Name	Data Type	Number	Description
user	User	`1`	꿈 작성자 정보
id	Integer	`1`	꿈 ID
description	String	`1`	꿈 상세 설명
start_at	String	`1`	시작일
complete_by	String	`1`	목표 종료일
tag	Integer	`1`	태그 번호
created_at	String	`1`	꿈 생성일
updated_at	String	`1`	꿈 최종 수정일
is_completed	Boolean	`1`	꿈 달성 여부
complete_at	String	`0...1`	(완료된 꿈일 경우) 달성 일자
review	String	`0...1`	(완료된 꿈일 경우) 후기
photo	String	`0...1`	(완료된 꿈일 경우) 사진 url

{
    "user": {
        "nickname": "test",
        "email": "[email protected]"
    },
    "id": 2,
    "title": "DREAM2 TITLE CHANG?E",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 1,
    "created_at": "2019-12-29T02:18:14.266897+09:00",
    "updated_at": "2019-12-29T02:18:14.267308+09:00",
    "is_completed": true,
    "complete_at": "2019-12-22",
    "review": "Second dream is completed",
    "photo": ""
}

꿈 추가

name	method	url	description
꿈 추가	`POST`	/dreams	새로운 꿈을 추가

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Body

Name	Data Type	Required	Default Value	Description
title	String	`true`	-	꿈의 제목
description	String	`false`	-	꿈에 대한 상세한 설명, 목표 등
start_at	Date	`false`	오늘 날짜	꿈 달성을 시작할 날자
complete_by	Date	`false`	-	꿈을 완료할 기한
tag	Integer	`true`	-	꿈이 속한 태그 번호

{
    "title": "second test",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 1
}

Response

Body

Name	Data Type	Number	Description
user	User	`1`	꿈 작성자 정보
id	Integer	`1`	꿈 ID
description	String	`1`	꿈 상세 설명
start_at	String	`1`	시작일
complete_by	String	`1`	목표 종료일
tag	Integer	`1`	태그 번호
created_at	String	`1`	꿈 생성일
updated_at	String	`1`	꿈 최종 수정일
is_completed	Boolean	`1`	꿈 달성 여부

{
    "user": {
        "nickname": "test",
        "email": "[email protected]"
    },
    "id": 2,
    "title": "second test",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 1,
    "created_at": "2019-12-29T01:39:50.308594+09:00",
    "updated_at": "2019-12-29T01:39:50.308929+09:00",
    "is_completed": false
}

꿈 수정

name	method	url	description
꿈 수정	`PATCH`	/dreams/{dreamId}	기존의 꿈 수정

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Body

Name	Data Type	Required	Default Value	Description
title	String	`false`	-	꿈의 제목
description	String	`false`	-	꿈에 대한 상세한 설명, 목표 등
start_at	Date	`false`	-	꿈 달성을 시작할 날자
complete_by	Date	`false`	-	꿈을 완료할 기한
tag	String	`false`	-	꿈이 속한 태그

{
	"title": "DREAM2 TITLE CHANG?E"
}

Response

Body

Name	Data Type	Number	Description
user	User	`1`	꿈 작성자 정보
id	Integer	`1`	꿈 ID
description	String	`1`	꿈 상세 설명
start_at	String	`1`	시작일
complete_by	String	`1`	목표 종료일
tag	Integer	`1`	태그 번호
created_at	String	`1`	꿈 생성일
updated_at	String	`1`	꿈 최종 수정일
is_completed	Boolean	`1`	꿈 달성 여부

{
    "user": {
        "nickname": "test",
        "email": "[email protected]"
    },
    "id": 2,
    "title": "DREAM2 TITLE CHANG?E",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 1,
    "created_at": "2019-12-29T01:39:50.308594+09:00",
    "updated_at": "2019-12-29T01:40:16.151289+09:00",
    "is_completed": false
}

꿈 삭제

name	method	url	description
꿈 삭제	`DELETE`	/dreams/{dreamId}	단일 꿈 삭제

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Response

Body 없음(성공시 204 No Content)

꿈 결과 추가

name	method	url	description
꿈 결과 추가	`POST`	/dreams/{dreamId}/result	꿈 달성시 상세 정보 기록

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Body

Name	Data Type	Required	Default Value	Description
complete_at	Date	`true`	-	꿈의 달성 일자
review	String	`true`	-	꿈 달성에 대한 상세 후기, 달성 내용, 방식 등
photo	Date	`false`	-	관련 사진 (현재 사용하지 않는 기능...ㅠㅠ 추후 사진 업로드 구현 예정)

{
    "complete_at": "2019-12-29",
    "review": "First dream is completed"
}

Response

Body

Name	Data Type	Number	Description
user	User	`1`	꿈 작성자 정보
id	Integer	`1`	꿈 ID
description	String	`1`	꿈 상세 설명
start_at	String	`1`	시작일
complete_by	String	`1`	목표 종료일
tag	Integer	`1`	태그 번호
created_at	String	`1`	꿈 생성일
updated_at	String	`1`	꿈 최종 수정일
is_completed	Boolean	`1`	꿈 달성 여부
complete_at	String	`1`	달성 일자
review	String	`1`	후기
photo	String	`1`	사진 url

{
    "user": {
        "nickname": "test",
        "email": "[email protected]"
    },
    "id": 1,
    "title": "first test",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 0,
    "created_at": "2019-12-29T02:35:48.445150+09:00",
    "updated_at": "2019-12-29T02:35:48.445391+09:00",
    "is_completed": true,
    "complete_at": "2019-12-29",
    "review": "First dream is completed",
    "photo": ""
}

꿈 결과 수정

name	method	url	description
꿈 결과 추가	`PATCH`	/dreams/{dreamId}/result	꿈 달성 결과 수정

Request

Header

Header Name	Required	Default Value	Description
Authorization	`true`	-	로그인/회원가입을 통해 얻은 토큰값 (`token <token>`)

Body

Name	Data Type	Required	Default Value	Description
complete_at	Date	`false`	-	꿈의 달성 일자
review	String	`false`	-	꿈 달성에 대한 상세 후기, 달성 내용, 방식 등
photo	Date	`false`	-	관련 사진 (현재 사용하지 않는 기능...ㅠㅠ 추후 사진 업로드 구현 예정)

{
    "review": "First dream is completed!!!! contents changed."
}

Response

Body

Name	Data Type	Number	Description
user	User	`1`	꿈 작성자 정보
id	Integer	`1`	꿈 ID
description	String	`1`	꿈 상세 설명
start_at	String	`1`	시작일
complete_by	String	`1`	목표 종료일
tag	Integer	`1`	태그 번호
created_at	String	`1`	꿈 생성일
updated_at	String	`1`	꿈 최종 수정일
is_completed	Boolean	`1`	꿈 달성 여부
complete_at	String	`1`	달성 일자
review	String	`1`	후기
photo	String	`1`	사진 url

{
    "user": {
        "nickname": "test",
        "email": "[email protected]"
    },
    "id": 1,
    "title": "first test",
    "description": "hello, this is test description",
    "start_at": "2019-12-22",
    "complete_by": "2020-12-22",
    "tag": 0,
    "created_at": "2019-12-29T02:35:48.445150+09:00",
    "updated_at": "2019-12-29T02:35:48.445391+09:00",
    "is_completed": true,
    "complete_at": "2019-12-29",
    "review": "First dream is completed!!!! contents changed.",
    "photo": ""
}

Dream API - mash-up-kr/real-backend GitHub Wiki

꿈 목록 조회

Request

Header

Response

Body

지난 꿈 목록 조회

Request

Header

Response

Body

단일 꿈 조회

Request

Header

Response

Body

꿈 추가

Request

Header

Body

Response

Body

꿈 수정

Request

Header

Body

Response

Body

꿈 삭제

Request

Header

Response

꿈 결과 추가

Request

Header

Body

Response

Body

꿈 결과 수정

Request

Header

Body

Response

Body

⚠️ **GitHub.com Fallback** ⚠️

⚠️ GitHub.com Fallback ⚠️