Auth
리프레시 토큰 갱신
HTTP request
GET /auth/refresh HTTP/1.1
Content-Type: application/json;charset=UTF-8
refresh_token: ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
access_token: asdfiuer3oidwf12.asdfoihoihn23vs.grwoi6ghrweiog5h
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 138
{
"access_token" : "asdfiuer3oidwf12.asdfoihoihn23vs.grwoi6ghrweiog5h",
"refresh_token" : "ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb"
}
Family
가족 생성
HTTP request
POST /families HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 3e83d3cd-061c-4d84-b7c3-78e09601285b
Content-Length: 42
Host: localhost:8080
{
"family_group_name" : "우리가족"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 35
{
"invite_code" : "oworiinvite"
}
가족 멤버 초대코드로 추가
HTTP request
POST /families/members HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 4ceab0bc-6a89-4256-bf78-85550798dd98
Content-Length: 48
Host: localhost:8080
{
"invite_code" : "길이가10인문자열!"
}
HTTP response
HTTP/1.1 200 OK
가족 그룹 이름 수정
HTTP request
POST /families/group-name HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 0cab2204-4dbd-4c0e-92ef-bb29b9364f9a
Content-Length: 42
Host: localhost:8080
{
"family_group_name" : "우리가족"
}
HTTP response
HTTP/1.1 200 OK
가족 이미지 저장
HTTP request
POST /families/images HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: d33c6969-9eb6-46e2-89fc-71442cef84cc
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=family_image; filename=image.jpg
Content-Type: image/jpeg
Image
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 43
{
"family_image" : "http://someUrlToS3"
}
가족 초대 코드 재생성
HTTP request
GET /families/code HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 2227c5bf-f47c-43c0-a48a-07e8a5c7864e
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 34
{
"invite_code" : "qeroiuh12y"
}
Image
이미지 업로드 - 이야기
HTTP request
POST /images HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Accept: application/json
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: db6ae4f5-e972-45d2-ae28-1e68f705af10
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=story_images; filename=image1.jpg
Content-Type: image/jpeg
Image 1
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=story_images; filename=image2.jpg
Content-Type: image/jpeg
Image 2
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 75
{
"story_images" : [ "http://storyImage1Url", "http://storyImage2Url" ]
}
Request parts
Part | Description |
---|---|
|
업로드 할 이미지 파일 |
Response fields
Path | Type | Description |
---|---|---|
|
|
이미지에 접근 가능한 url |
Story
이야기 등록
HTTP request
POST /stories HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: ae7ba7e3-109c-480b-b154-a05ec53af98d
Content-Length: 662
Host: localhost:8080
{
"start_date" : "2017-12-25",
"end_date" : "2017-12-30",
"title" : "기다리고 기다리던 하루",
"content" : "종강하면 동해바다로 가족 여행 가자고 한게 엊그제 같았는데...3박 4일 동해여행 너무 재밌었어!! 날씨도 너무 좋았고 특히 갈치조림이 대박 ㄹㅇ 맛집 인정... 2일차 점심 때 대림공원 안에서 피크닉한게 가장 기억에 남았던거 같아! 엄마가 만들어 준 샌드위치는 세상에서 젤 맛있어 이거 팔면 대박날듯 ㅋㅋㅋ ",
"story_images" : [ "http://storyImage1Url", "http://storyImage2Url", "http://storyImage3Url", "http://storyImage4Url" ]
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 57
{
"story_id" : "37484171-96e1-404c-8937-9ab9e07a0945"
}
Request fields
Path | Type | Description |
---|---|---|
|
|
활동 시작 일자 |
|
|
활동 종료 일자 |
|
|
story 제목 |
|
|
story 내용 |
|
|
이미지 리스트 (null 가능 / 최대 10장) |
Response fields
Path | Type | Description |
---|---|---|
|
|
생성된 story의 id |
이야기 수정
HTTP request
POST /stories/update HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: cd298a2e-11ad-4ebd-9cd3-cd73eb823bd4
Content-Length: 717
Host: localhost:8080
{
"story_id" : "58b68fb9-e4fb-40d9-8967-23164a3bb049",
"start_date" : "2012-12-25",
"end_date" : "2012-12-25",
"title" : "기다리고 기다리던 하루",
"content" : "종강하면 동해바다로 가족 여행 가자고 한게 엊그제 같았는데...3박 4일 동해여행 너무 재밌었어!! 날씨도 너무 좋았고 특히 갈치조림이 대박 ㄹㅇ 맛집 인정... 2일차 점심 때 대림공원 안에서 피크닉한게 가장 기억에 남았던거 같아! 엄마가 만들어 준 샌드위치는 세상에서 젤 맛있어 이거 팔면 대박날듯 ㅋㅋㅋ ",
"story_images" : [ "http://storyImage1Url", "http://storyImage2Url", "http://storyImage3Url", "http://storyImage4Url" ]
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 57
{
"story_id" : "15e22b46-0522-4e25-b2ea-244f9b34d315"
}
Request fields
Path | Type | Description |
---|---|---|
|
|
수정할 story의 id |
|
|
수정할 활동 시작 일자 |
|
|
수정할 활동 종료 일자 |
|
|
수정할 story 제목 |
|
|
수정할 story 내용 |
|
|
수정할 이미지 리스트 (null 가능 / 최대 10장) |
이야기 삭제
HTTP request
DELETE /stories/37b864c8-7dea-4f1f-902e-5d4e15fa162e HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 2eee7550-62a1-49b8-8089-7442e56280c5
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Path parameters
Parameter | Description |
---|---|
|
삭제할 story id |
이야기 전체 조회 (날짜순)
HTTP request
GET /stories?sort=start_date&page=1&size=4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 4c275bbd-386b-4dcb-acab-d42e9c1ddf28
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2104
{
"stories" : [ {
"story_id" : "25be9fd1-b54b-449d-8789-663edc5ef590",
"title" : "신나는 가족여행",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 2,
"comment_count" : 2,
"writer" : "고구마",
"start_date" : "2002-02-01",
"end_date" : "2002-02-02"
}, {
"story_id" : "b57e8bab-85ed-46a2-9c0b-60f9dce14710",
"title" : "맛있는 저녁식사",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "null",
"is_multiple_images" : false,
"heart_count" : 0,
"comment_count" : 0,
"writer" : "구운계란",
"start_date" : "2005-02-01",
"end_date" : "2005-02-03"
}, {
"story_id" : "35eef273-3053-41c4-9525-177c11dc73eb",
"title" : "못난이 생일잔치",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 1,
"comment_count" : 0,
"writer" : "허망고",
"start_date" : "2012-02-01",
"end_date" : "2012-02-02"
}, {
"story_id" : "63a807b8-b3ff-4e0c-b9a9-014903f3fc3a",
"title" : "다같이 보드게임 했던 날",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용 이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : true,
"heart_count" : 2,
"comment_count" : 3,
"writer" : "허지롱이",
"start_date" : "2022-02-01",
"end_date" : "2022-12-03"
} ],
"next_page" : 2,
"last_page" : 4
}
Request parameters
Parameter | Description |
---|---|
|
정렬 기준 (날짜순 start_date / 최신순 created_at) |
|
현재 페이지 |
|
불러올 게시글 개수 |
Response fields
Path | Type | Description |
---|---|---|
|
|
조회한 story 리스트 |
|
|
story의 id |
|
|
제목 |
|
|
내용 |
|
|
대표 이미지 |
|
|
여러 이미지 인가 |
|
|
좋아요 개수 |
|
|
댓글 개수 |
|
|
작성자 |
|
|
활동 시작 일자 |
|
|
활동 종료 일 |
|
|
다음 페이지 번호 / (-1인 경우 마지막 페이지) |
|
|
마지막 페이지 번호 / (-1인 경우 마지막 페이지) |
이야기 전체 조회 (최신순)
HTTP request
GET /stories?sort=created_at&page=1&size=4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: d135096a-e28f-4ff2-9803-eec2d3a84c2c
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2102
{
"stories" : [ {
"story_id" : "40456263-74a5-402c-9e27-af0093711e32",
"title" : "다같이 보드게임 했던 날",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용 이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 2,
"comment_count" : 3,
"writer" : "허지롱이",
"start_date" : "2022-02-01",
"end_date" : "2022-12-03"
}, {
"story_id" : "04f1d80a-3bc5-4203-890a-44f03d2d2f45",
"title" : "못난이 생일잔치",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 1,
"comment_count" : 0,
"writer" : "허망고",
"start_date" : "2012-02-01",
"end_date" : "2012-02-02"
}, {
"story_id" : "dbe88c24-2d33-4bde-b0cf-0d62eb93ccc5",
"title" : "맛있는 저녁식사",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : null,
"is_multiple_images" : false,
"heart_count" : 0,
"comment_count" : 0,
"writer" : "구운계란",
"start_date" : "2005-02-01",
"end_date" : "2005-02-03"
}, {
"story_id" : "6fc58ce7-73a4-4cec-886a-3f4579925447",
"title" : "신나는 가족여행",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : true,
"heart_count" : 2,
"comment_count" : 2,
"writer" : "고구마",
"start_date" : "2002-02-01",
"end_date" : "2002-02-02"
} ],
"next_page" : 2,
"last_page" : 4
}
이야기 상세 조회
HTTP request
GET /stories/8ec0d6cc-69d0-46c8-a5af-e9f845260290 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: debf9449-387c-42ed-ad4f-11c9fecd91a3
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1783
{
"story_id" : "ee7b6d0e-9ad4-4d24-b4b7-58268ddaa7ed",
"is_liked" : true,
"story_images" : [ "image2.png", "image3.png", "image2.png", "image3.png", "image3.png" ],
"title" : "~ 다같이 야구 보고온 날 ~",
"writer" : "김건빵",
"content" : "오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 오늘은 엘지가 이겼다. 얏호",
"heart_count" : 5,
"comment_count" : 4,
"comments" : [ {
"parent_comment_id" : null,
"comment_id" : "6da8a00c-b1df-4496-a8d7-6323294ba0ef",
"comment" : "야호 첫번째 최상위 댓글입니다.",
"writer" : "허지렁지렁",
"time_before_writing" : "3시간 전",
"delete_comment_check" : false
}, {
"parent_comment_id" : "6da8a00c-b1df-4496-a8d7-6323294ba0ef",
"comment_id" : "b21df995-2a4d-4668-8626-85c6c75b2570",
"comment" : "첫번째 대댓글입니다.",
"writer" : "김건빵",
"time_before_writing" : "2시간 전",
"delete_comment_check" : false
}, {
"parent_comment_id" : "6da8a00c-b1df-4496-a8d7-6323294ba0ef",
"comment_id" : "6ee9ec3f-72ed-4ca0-9765-b51389a5fc02",
"comment" : "두번째 대댓글입니다.",
"writer" : "고구마",
"time_before_writing" : "30분 전",
"delete_comment_check" : false
}, {
"parent_comment_id" : null,
"comment_id" : "c121bc5b-648b-4c80-aa45-19ec1791c63f",
"comment" : "야호 두번째 최상위댓글입니다.",
"writer" : "아몬드",
"time_before_writing" : "2시간 전",
"delete_comment_check" : false
} ],
"start_date" : "2023-10-06",
"end_date" : "2023-10-06",
"thumbnail" : "image2.png"
}
Path parameters
Parameter | Description |
---|---|
|
조회할 story id |
Response fields
Path | Type | Description |
---|---|---|
|
|
story id |
|
|
로그인 한 유저가 좋아요를 눌렀는지 |
|
|
이미지 리스트 (null 가능 / 최대 10장) |
|
|
제목 |
|
|
작성자 |
|
|
내용 |
|
|
좋아요 개수 |
|
|
댓글 개수 |
|
|
댓글 리스트 |
|
|
댓글의 부모 댓글 id |
|
|
댓글의 id |
|
|
댓글 내용 |
|
|
댓글 작성자 |
|
|
댓글 작성 후 지난 시간 |
|
|
댓글이 삭제되었는지 |
|
|
story의 활동 시작 날짜 |
|
|
story 활동 종료 날짜 |
|
|
대표 이미지 |
이야기 검색
HTTP request
GET /stories/search?keyword=%EB%AA%BB%EB%82%9C%EC%9D%B4&page=10&size=4 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 10e3fe78-5831-418b-a727-6e36c5e88d0b
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2100
{
"stories" : [ {
"story_id" : "71905e47-de70-4fbb-9c10-01e597191705",
"title" : "룰루랄라",
"content" : "이야기 내용입니다 못난이 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 2,
"comment_count" : 2,
"writer" : "고구마",
"start_date" : "2022-02-01",
"end_date" : "2022-02-02"
}, {
"story_id" : "a95dd1d8-5506-4379-8bea-a4ff98f3366d",
"title" : "못난이 외식 했지롱",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : null,
"is_multiple_images" : false,
"heart_count" : 0,
"comment_count" : 0,
"writer" : "구운계란",
"start_date" : "2005-02-01",
"end_date" : "2019-02-03"
}, {
"story_id" : "fe01b7ca-4104-4c2d-b8b4-4d477285cc1b",
"title" : "생일잔치",
"content" : "못난이 이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 1,
"comment_count" : 0,
"writer" : "허망고",
"start_date" : "2011-02-01",
"end_date" : "2011-02-02"
}, {
"story_id" : "d529b7b7-1de3-4dc8-b354-3057f3059091",
"title" : "쇼핑 데이 with 못난이",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용 이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : true,
"heart_count" : 2,
"comment_count" : 3,
"writer" : "못난이",
"start_date" : "2010-02-01",
"end_date" : "2022-12-03"
} ],
"next_page" : 10,
"last_page" : -1
}
Request parameters
Parameter | Description |
---|---|
|
검색어 |
|
현재 페이지 |
|
조회한 페이지 개수 |
유저가 작성한 이야기 조회
HTTP request
GET /stories/member?sort=start_date&page=11&size=2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 699701c0-4139-4c9f-b48f-d79874ac8631
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1087
{
"stories" : [ {
"story_id" : "8d7e84b6-f0a5-40b8-9c68-925c472e4e9a",
"title" : "룰루랄라",
"content" : "이야기 내용입니다 못난이 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 2,
"comment_count" : 2,
"writer" : "고구마",
"start_date" : "2022-02-01",
"end_date" : "2022-02-02"
}, {
"story_id" : "03d3624e-7f97-4584-bf50-df718ec084d0",
"title" : "못난이 외식 했지롱",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 0,
"comment_count" : 0,
"writer" : "구운계란",
"start_date" : "2005-02-01",
"end_date" : "2019-02-03"
} ],
"next_page" : 12,
"last_page" : 21
}
유저가 좋아한 이야기 조회
HTTP request
GET /stories/heart?sort=created_at&page=1&size=2 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: f6b10724-ce93-41d8-ba6c-f0ea824fabd1
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 996
{
"stories" : [ {
"story_id" : "dd41b0f6-0f96-417c-a557-0d87016bbbfb",
"title" : "선풍기 청소한 날",
"content" : "이야기 내용입니다 못난이 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : "https://owori.s3.ap-northeast-2.amazonaws.com/story/Group%2010_f985a58a-1257-4691-88ee-e2b75977fb3e.png",
"is_multiple_images" : false,
"heart_count" : 2,
"comment_count" : 2,
"writer" : "고구마",
"start_date" : "2022-02-01",
"end_date" : "2022-02-02"
}, {
"story_id" : "2c4272ee-924f-4ee6-814b-abbc4f79bfc9",
"title" : "못난이 외식 했지롱",
"content" : "이야기 내용입니다 내용 내용 내용 내용 내용 내용 내용 내용 내용",
"thumbnail" : null,
"is_multiple_images" : false,
"heart_count" : 0,
"comment_count" : 0,
"writer" : "구운계란",
"start_date" : "2005-02-01",
"end_date" : "2019-02-03"
} ],
"next_page" : 2,
"last_page" : 12
}
Schedule
일정 등록
HTTP request
POST /schedule HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 78588496-6e21-4c64-8d6e-bd557f5d3f6a
Content-Length: 222
Host: localhost:8080
{
"title" : "가족 여행",
"content" : "재밌겠다.",
"start_date" : "2024-07-31",
"end_date" : "2024-08-02",
"schedule_type" : "FAMILY",
"dday_option" : true,
"alarm_options" : [ "TODAY", "A_DAY_AGO" ]
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 60
{
"schedule_id" : "c6cd3579-624c-4015-9631-9e438590b173"
}
일정 수정
HTTP request
POST /schedule/update HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: a0d6840e-6678-48e3-9106-fb7c58f79988
Content-Length: 229
Host: localhost:8080
{
"schedule_id" : "945d336a-5501-40f5-9b87-fe2e2b68c1ff",
"title" : "가족 여행",
"content" : "재밌겠다.",
"start_date" : "2024-07-31",
"end_date" : "2024-08-04",
"dday_option" : true,
"alarm_options" : [ ]
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 60
{
"schedule_id" : "7667f479-5052-475c-b8a7-658b68f0f71c"
}
일정 삭제
HTTP request
DELETE /schedule/34e358fc-3834-42dd-897b-74bf97c730da HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 4b12c9ed-4990-41e3-a417-53327c2d8294
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
일정 월별 조회
HTTP request
GET /schedule/month?year_month=2023-07 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: e8189573-28c8-4f80-b5e1-bd8f65f72ba1
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 982
[ {
"schedule_id" : "34a52e4c-f528-48ca-8e49-559d1bd289ee",
"title" : "친구랑 여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-08",
"end_date" : "2023-07-09",
"schedule_type" : "INDIVIDUAL",
"nickname" : "벡스",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "TODAY" ]
}, {
"schedule_id" : "f5022d24-f95c-4c33-970b-b4facbcf97fc",
"title" : "코딩 테스트",
"content" : "재밌겠다.",
"start_date" : "2023-07-15",
"end_date" : "2023-07-15",
"schedule_type" : "INDIVIDUAL",
"nickname" : "오월이",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "A_DAY_AGO" ]
}, {
"schedule_id" : "00afca8f-0d6d-4667-8597-408e3007ce6c",
"title" : "가족여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-31",
"end_date" : "2023-08-02",
"schedule_type" : "FAMILY",
"nickname" : "가족",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "A_DAY_AGO", "A_WEEK_AGO" ]
} ]
가족별 디데이 조회
HTTP request
GET /schedule/dday HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 5eaccd51-8615-4a94-a491-11dd8b008ca0
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1099
[ {
"schedule_id" : "e5ae222e-d1da-4f26-a22c-22b099d009e5",
"title" : "친구랑 여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-16",
"end_date" : "2023-07-09",
"dday" : "D-DAY",
"schedule_type" : "INDIVIDUAL",
"nickname" : "벡스",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "TODAY" ],
"is_mine" : true
}, {
"schedule_id" : "1d935e92-7f39-42ff-89cb-2d5e552da9f8",
"title" : "코딩 테스트",
"content" : "재밌겠다.",
"start_date" : "2023-07-17",
"end_date" : "2023-07-15",
"dday" : "D-1",
"schedule_type" : "INDIVIDUAL",
"nickname" : "오월이",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "A_DAY_AGO" ],
"is_mine" : true
}, {
"schedule_id" : "b4a7d907-e2cb-4463-995b-0c3bb36bc376",
"title" : "가족여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-31",
"end_date" : "2023-08-02",
"dday" : "D-15",
"schedule_type" : "FAMILY",
"nickname" : "벡스",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ "A_DAY_AGO", "A_WEEK_AGO" ],
"is_mine" : true
} ]
Member
카카오 멤버 생성 및 Jwt 토큰 생성
HTTP request
POST /members/kakao HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 56
Host: localhost:8080
{
"token" : "382y5e3a5",
"auth_provider" : "KAKAO"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 259
{
"member_id" : "7aefaa8b-81b9-4ff5-a662-555218f1e2ed",
"is_service_member" : true,
"jwt_token" : {
"access_token" : "accesasdfagfwaerg.tokenasfd13sad.isthisahtfgwiueoh",
"refresh_token" : "refreshriuqwhfoieu.tokenqiweurhu.isthiswheoituhw"
}
}
애플 멤버 생성 및 Jwt 토큰 생성
HTTP request
POST /members/apple HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 89
Host: localhost:8080
{
"token" : "382y5e3a5",
"authorization_code" : "code",
"auth_provider" : "APPLE"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 259
{
"member_id" : "49f48446-964d-4e9f-9a5c-4cbe40f4ce01",
"is_service_member" : true,
"jwt_token" : {
"access_token" : "accesasdfagfwaerg.tokenasfd13sad.isthisahtfgwiueoh",
"refresh_token" : "refreshriuqwhfoieu.tokenqiweurhu.isthiswheoituhw"
}
}
구글 멤버 생성 및 Jwt 토큰 생성
HTTP request
POST /members/google HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 57
Host: localhost:8080
{
"token" : "382y5e3a5",
"auth_provider" : "GOOGLE"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 259
{
"member_id" : "7e537dfa-12fe-4100-b440-9de0e38a8d21",
"is_service_member" : true,
"jwt_token" : {
"access_token" : "accesasdfagfwaerg.tokenasfd13sad.isthisahtfgwiueoh",
"refresh_token" : "refreshriuqwhfoieu.tokenqiweurhu.isthiswheoituhw"
}
}
멤버 초기 정보 업데이트
HTTP request
POST /members/details HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 36bf3abd-d0a0-4d04-8fa2-d8195be4b226
Content-Length: 55
Host: localhost:8080
{
"nickname" : "owori",
"birthday" : "2023-10-06"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 32
{
"is_service_member" : true
}
멤버 프로필 이미지 저장
HTTP request
POST /members/profile-image HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8; boundary=6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 679a1be0-60d2-4e90-abe8-71ddda8fd8d3
Host: localhost:8080
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm
Content-Disposition: form-data; name=profile_image; filename=image.jpg
Content-Type: image/jpeg
Image
--6o2knFse3p53ty9dmcQvWAIx1zInP11uCfbm--
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 47
{
"profile_image" : "http://someImageToUrl"
}
멤버 프로필 업데이트
HTTP request
POST /members/profile HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: b25f9724-d032-409b-bfd0-6663f45e5953
Content-Length: 80
Host: localhost:8080
{
"nickname" : "오월이",
"birthday" : "2023-10-06",
"color" : "GREEN"
}
HTTP response
HTTP/1.1 200 OK
멤버 회원 탈퇴
HTTP request
DELETE /members HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 09c4f439-a333-4871-8f8f-b778d4312cd3
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
멤버 감정 뱃지 업데이트
HTTP request
POST /members/emotional-badge HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 1e0f06ef-c4f3-439a-a64a-092de7af7bd0
Content-Length: 33
Host: localhost:8080
{
"emotional_badge" : "HAPPY"
}
HTTP response
HTTP/1.1 200 OK
멤버 홈화면 조회
HTTP request
GET /members/home HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: d0649e9f-efcd-4858-91fb-aa9db3bb6d28
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 2346
{
"family_group_name" : "오월이 가족",
"member_profiles" : [ {
"id" : "7b851c22-b318-4029-acfc-3879d8b7b419",
"nickname" : "아빠",
"profile_image" : "http://someProfileImageUrl",
"emotional_badge" : "SO_HAPPY"
}, {
"id" : "926b5403-891e-43e3-8092-ae37fb0456f3",
"nickname" : "엄마",
"profile_image" : "http://someProfileImageUrl",
"emotional_badge" : "JOY"
}, {
"id" : "af713250-56a0-473b-8620-76cfdb56a585",
"nickname" : "아들",
"profile_image" : "http://someProfileImageUrl",
"emotional_badge" : "CRY"
} ],
"dday_schedules" : [ {
"schedule_id" : "b6f7b17d-61f1-46ac-a718-2093bfbbacb9",
"title" : "가족 여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-20",
"end_date" : "2023-07-23",
"dday" : "D-3",
"schedule_type" : "FAMILY",
"nickname" : "벡스",
"color" : "BLUE",
"dday_option" : true,
"alarm_options" : [ ],
"is_mine" : true
}, {
"schedule_id" : "fc62cf89-88e6-4900-a259-f8f6d1a43a35",
"title" : "휴가",
"content" : "재밌겠다.",
"start_date" : "2023-07-24",
"end_date" : "2023-07-28",
"dday" : "D-3",
"schedule_type" : "INDIVIDUAL",
"nickname" : "오월이",
"color" : "SKYBLUE",
"dday_option" : true,
"alarm_options" : [ ],
"is_mine" : true
}, {
"schedule_id" : "902fea97-44d7-4d9f-8caa-b877bd85d630",
"title" : "친구 여행",
"content" : "재밌겠다.",
"start_date" : "2023-07-30",
"end_date" : "2023-08-03",
"dday" : "D-3",
"schedule_type" : "INDIVIDUAL",
"nickname" : "벡스",
"color" : "GREEN",
"dday_option" : true,
"alarm_options" : [ ],
"is_mine" : true
} ],
"family_images" : [ "111111", "222222" ],
"family_sayings" : [ {
"saying_id" : "e1db7407-0791-4c08-87ab-fdfa7ff8f1aa",
"content" : "오늘 회식해요",
"member_id" : "7b851c22-b318-4029-acfc-3879d8b7b419",
"tag_members_id" : [ "540b62a9-6b5c-48aa-ac5b-633752368d24", "1a7d9a26-b9b6-49ad-88ac-2d35971bfcfa" ],
"updated_at" : "2023-10-06T13:21:47.123016"
}, {
"saying_id" : "7fcb37a2-5726-4d64-812d-026d4b72b217",
"content" : "오늘 저녁 카레",
"member_id" : "926b5403-891e-43e3-8092-ae37fb0456f3",
"tag_members_id" : [ ],
"updated_at" : "2023-10-06T13:21:47.123051"
} ]
}
마이페이지 유저 프로필 조회
HTTP request
GET /members/profile HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 5c31c746-8821-4f8c-b45b-be5056f9f72d
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 202
{
"nickname" : "꼼지락",
"birthday" : "2000-04-22",
"color" : "BLUE",
"emotional_badge" : "HAPPY",
"profile_image" : "http://someProfileImageUrl",
"story_count" : 3,
"heart_count" : 6
}
멤버 수정불가한 색상 조회
true인 색상에 수정 불가 표시하기
HTTP request
GET /members/colors HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: beee7afa-62db-4ad5-8722-ffd65d1e682d
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 134
{
"red" : false,
"yellow" : true,
"green" : false,
"pink" : false,
"skyblue" : false,
"blue" : false,
"purple" : false
}
Heart
좋아요 생성 / 취소
HTTP request
POST /hearts HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: ccc7d021-4de7-43ef-8e22-55510b50f67c
Content-Length: 57
Host: localhost:8080
{
"story_id" : "f7008a39-25f5-4ab6-b822-66daf7e934e6"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 23
{
"is_liked" : true
}
Request fields
Path | Type | Description |
---|---|---|
|
|
좋아요 누를 story의 id |
Response fields
Path | Type | Description |
---|---|---|
|
|
좋아요 여부 |
Comment
댓글 작성
HTTP request
POST /comments HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: acc1b5fc-9605-431d-824f-66b6d4af6577
Content-Length: 261
Host: localhost:8080
{
"story_id" : "8d9177d9-4ca9-40e5-9f8e-58bdad4d9f8f",
"parent_comment_id" : null,
"content" : "여기엔 댓글 내용을 적어주시면 됩니다. 작성하는 댓글이 최상위 댓글인 경우에는 parentCommentId에 null을 담아주세요 >_<"
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 59
{
"comment_id" : "944b2218-6473-499d-b221-583316dce4b9"
}
Request fields
Path | Type | Description |
---|---|---|
|
|
댓글을 작성할 story의 id |
|
|
부모 댓글의 id (null도 가능) |
|
|
댓글 내용 |
Response fields
Path | Type | Description |
---|---|---|
|
|
댓글의 id |
댓글 삭제
HTTP request
DELETE /comments/7a19a1b1-9aae-4f85-a781-041eac66852b HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: d9d39324-bdcb-4c11-aa6b-4f6b551d287d
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Path parameters
Parameter | Description |
---|---|
|
삭제할 댓글의 id |
댓글 수정
HTTP request
POST /comments/update HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 00056e10-2cd6-4229-ae19-fdb0e1ab3f30
Content-Length: 100
Host: localhost:8080
{
"comment_id" : "c690a9a2-9a8d-4100-a47d-0aab0c4631d1",
"comment" : "수정할 댓글 내용"
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 59
{
"comment_id" : "c690a9a2-9a8d-4100-a47d-0aab0c4631d1"
}
Request fields
Path | Type | Description |
---|---|---|
|
|
수정할 댓글의 id |
|
|
수정할 댓글 내용 |
Saying
서로에게 한마디 등록
HTTP request
POST /saying HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: b7c0bb87-3729-4115-9149-43932cbbc99b
Content-Length: 73
Host: localhost:8080
{
"content" : "오늘 집 안 들어가요",
"tag_members_id" : [ ]
}
HTTP response
HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 58
{
"saying_id" : "e9eb481c-89ce-4794-9e0e-4cdba2e5cf8f"
}
서로에게 한마디 수정
HTTP request
POST /saying/update HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 3d36796e-71bb-49a7-bca3-8546a62397ba
Content-Length: 164
Host: localhost:8080
{
"saying_id" : "a619f0a1-1228-44a8-8f54-c6ecb4b97cdb",
"content" : "오늘 집 들어갈래",
"tag_members_id" : [ "6f7245eb-23d7-411e-a731-938e27975fb5" ]
}
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 58
{
"saying_id" : "4ab02859-5048-43e9-bc90-bd3cc5774b61"
}
서로에게 한마디 삭제
HTTP request
DELETE /saying/84379e74-1282-44f3-b342-408d9c6dd421 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 71e6e6c8-e9d7-4293-afe6-39fc31c68b77
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
서로에게 한마디 가족 단위 조회
HTTP request
GET /saying HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: f0646cfa-bc51-4ecd-8450-0048abaf40d3
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 507
[ {
"saying_id" : "d9ea5a60-3c03-46b0-8caa-ec4f747e7a47",
"content" : "오늘 집 안들어가요",
"member_id" : "77918691-4c4e-4b2f-90bc-a47c0c78e1e3",
"tag_members_id" : [ ],
"updated_at" : "2023-10-06T13:21:47.478886"
}, {
"saying_id" : "2cd1436b-11f5-48d9-a95e-7fea7b92d8a5",
"content" : "밥 먹고 들어갈게요",
"member_id" : "580b86a3-6461-41f9-b6e8-9ee59b109292",
"tag_members_id" : [ "f42619c7-70db-4b97-aaae-80d03d5c6b56" ],
"updated_at" : "2023-10-06T13:21:47.478916"
} ]
Keyword
최신 검색어 조회
HTTP request
GET /keywords HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: cc5e0a60-9c61-4050-afef-b2092e77b547
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 270
[ {
"keyword_id" : "2cef68ab-61da-4e2c-9f49-7f00b03f2d81",
"content" : "강화도"
}, {
"keyword_id" : "d6080edf-445c-46e9-8e3a-15f02585cd04",
"content" : "간장 게장"
}, {
"keyword_id" : "cd20a987-d70c-40fb-8537-deb2a404f0c8",
"content" : "야구장"
} ]
Response fields
Path | Type | Description |
---|---|---|
|
|
검색어 id |
|
|
검색어 |
최신 검색어 단일 삭제
HTTP request
DELETE /keywords/38c99ba6-887e-4040-a7fa-d55df38d196a HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: daa6d4f2-d3d7-4a18-8d1f-cbf0b7e21b7c
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK
Path parameters
Parameter | Description |
---|---|
|
삭제할 키워드의 id |
최신 검색어 전체 삭제
HTTP request
DELETE /keywords HTTP/1.1
Content-Type: application/json;charset=UTF-8
Authorization: Bearer ghuriewhv32j12.oiuwhftg32shdi.ogiurhw0gb
member_id: 3c6d5664-6826-4949-b75f-61217504c324
Host: localhost:8080
HTTP response
HTTP/1.1 200 OK