Book Review

북리뷰 생성

HTTP request

POST /book-reviews HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 328
Host: 223.255.205.62:30505

{
  "book" : {
    "isbn" : "9791188116065",
    "title" : "미움 받을 용기",
    "author" : "독도독도",
    "publisher" : "test_b64e856b1458",
    "imageUrl" : "http://aaa.bb.com",
    "price" : 62,
    "publishAt" : "2023-02-27"
  },
  "title" : "제목1",
  "content" : "내용1",
  "score" : 5,
  "difficulty" : 5
}

HTTP response

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 403

{
  "id" : 1,
  "writer" : {
    "id" : "03e2eb95-e450-4232-9990-0617d4f93fef",
    "name" : "작성자"
  },
  "title" : "제목",
  "content" : "내용",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.905928"
}

북리뷰 조회 (옵션 없음)

HTTP request

GET /book-reviews HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1302

[ {
  "id" : 1,
  "writer" : {
    "id" : "9580d7ed-caeb-4d85-b1b9-f7f7aa2bb175",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.935648"
}, {
  "id" : 2,
  "writer" : {
    "id" : "e633ceae-3b1a-4a39-bd6a-552fb5e91393",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.935662"
}, {
  "id" : 3,
  "writer" : {
    "id" : "3ffcda70-f369-4cba-b017-ad6e74f7d243",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.935679"
}, {
  "id" : 4,
  "writer" : {
    "id" : "ce8be30a-ebbc-45e8-ba86-6f9855092466",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.935691"
} ]

북리뷰 조회 (페이징 옵션)

HTTP request

GET /book-reviews?page=0&size=12&sort=createdAt%2Cdesc HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1302

[ {
  "id" : 1,
  "writer" : {
    "id" : "211e2e72-afdc-4aa5-b36c-4fcab393d3a9",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.922602"
}, {
  "id" : 2,
  "writer" : {
    "id" : "a566c0e1-8ddf-4266-a217-81633bd2126f",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.922669"
}, {
  "id" : 3,
  "writer" : {
    "id" : "bce6e4c4-7527-4343-b941-85a39b4dcc94",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.922684"
}, {
  "id" : 4,
  "writer" : {
    "id" : "428448b0-1542-459f-9e24-b9c1b4058fb7",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.922697"
} ]

북리뷰 조회 (검색 옵션)

HTTP request

GET /book-reviews?content=conconcon&bookname=herry&writer=popoter HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1302

[ {
  "id" : 1,
  "writer" : {
    "id" : "04e0b16d-b9f8-4330-b993-90474cb96837",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.952758"
}, {
  "id" : 2,
  "writer" : {
    "id" : "70a485b7-50d1-47c5-8fda-5e7620c8a1d7",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.952782"
}, {
  "id" : 3,
  "writer" : {
    "id" : "4ba30b93-c3e0-4dd7-8418-d52bd0cf072c",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.952794"
}, {
  "id" : 4,
  "writer" : {
    "id" : "282ac887-bdfe-4562-b59d-b79f0a153e06",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.952798"
} ]

북리뷰 조회 (검색 옵션 & 페이징 옵션)

HTTP request

GET /book-reviews?page=0&size=12&sort=createdAt%2Cdesc&content=conconcon&bookname=herry&writer=popoter HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1301

[ {
  "id" : 1,
  "writer" : {
    "id" : "9a086d94-c15a-42da-bde6-200dc5ac95e2",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.944003"
}, {
  "id" : 2,
  "writer" : {
    "id" : "8e008eaf-0336-4827-a12f-481aa460738b",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.94403"
}, {
  "id" : 3,
  "writer" : {
    "id" : "93e2820f-9694-45b2-bf63-029cfd17f0e1",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.944035"
}, {
  "id" : 4,
  "writer" : {
    "id" : "c6353f0f-ab74-4c1c-abd0-636a743ab29a",
    "name" : "작성자"
  },
  "title" : "제목",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.944048"
} ]

북리뷰 단일 조회

HTTP request

GET /book-reviews/5 HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 403

{
  "id" : 1,
  "writer" : {
    "id" : "d1f6283b-c99b-41c9-bd52-b6a5e338f580",
    "name" : "작성자"
  },
  "title" : "제목",
  "content" : "내용",
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "likeCount" : 5,
  "score" : 5,
  "difficulty" : 5,
  "createdAt" : "2023-02-27T11:35:33.882198"
}

북리뷰 수정

HTTP request

PUT /book-reviews/5 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 328
Host: 223.255.205.62:30505

{
  "book" : {
    "isbn" : "9791188116065",
    "title" : "미움 받을 용기",
    "author" : "독도독도",
    "publisher" : "test_b64e856b1458",
    "imageUrl" : "http://aaa.bb.com",
    "price" : 62,
    "publishAt" : "2023-02-27"
  },
  "title" : "제목1",
  "content" : "내용1",
  "score" : 5,
  "difficulty" : 5
}

HTTP response

HTTP/1.1 204 No Content

Book Review Comment

댓굴 생성

HTTP request

POST /book-review-comments HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 75
Host: 223.255.205.62:30505

{
  "bookReviewId" : 5,
  "parentId" : null,
  "content" : "댓글내용"
}

HTTP response

HTTP/1.1 201 Created

북리뷰ID에 해당하는 댓글 조회

HTTP request

GET /book-review-comments?bookReviewId=5 HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 786

[ {
  "id" : 5,
  "writer" : {
    "id" : "7e6225b8-7e71-4300-9f92-457bcbcf918f",
    "name" : "작성자 이름"
  },
  "content" : "댓글 내용",
  "createdAt" : "2023-02-27T11:35:31.743132"
}, {
  "id" : 6,
  "writer" : {
    "id" : "ad48901b-c1a4-4406-8e90-401a5111875b",
    "name" : "작성자 이름"
  },
  "content" : "댓글 내용",
  "createdAt" : "2023-02-27T11:35:31.743173"
}, {
  "id" : 7,
  "writer" : {
    "id" : "a6961fbb-4dc4-4beb-a98d-9b71b0b6481f",
    "name" : "작성자 이름"
  },
  "content" : "댓글 내용",
  "createdAt" : "2023-02-27T11:35:31.743188"
}, {
  "id" : 8,
  "writer" : {
    "id" : "5af4d2f7-4ab3-468e-8a02-994092cd318e",
    "name" : "작성자 이름"
  },
  "content" : "댓글 내용",
  "createdAt" : "2023-02-27T11:35:31.743201"
} ]

Book Borrow

책 대여 생성

HTTP request

POST /book-borrows HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 334
Host: 223.255.205.62:30505

{
  "book" : {
    "isbn" : "9791188116065",
    "title" : "미움 받을 용기",
    "author" : "독도독도",
    "publisher" : "test_b64e856b1458",
    "imageUrl" : "http://aaa.bb.com",
    "price" : 62,
    "publishAt" : "2023-02-27"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}

HTTP response

HTTP/1.1 201 Created
Content-Type: application/json;charset=UTF-8
Content-Length: 367

{
  "id" : 5,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "9ee90de9-1bb9-404f-838e-79bc8f91924a",
    "name" : "작성자"
  },
  "borrower" : null,
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}

책 대여 목록 조회

HTTP request

GET /book-borrows HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 334
Host: 223.255.205.62:30505

{
  "book" : {
    "isbn" : "9791188116065",
    "title" : "미움 받을 용기",
    "author" : "독도독도",
    "publisher" : "test_b64e856b1458",
    "imageUrl" : "http://aaa.bb.com",
    "price" : 62,
    "publishAt" : "2023-02-27"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1340

[ {
  "id" : 5,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "0a7fe071-6fc4-4d08-955d-f57a2166fe28",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "50787f84-3942-466c-8afc-a2fa1f6a4718",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 4,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "6e9640bc-6f3d-4b8f-a5ec-17c31dac8c82",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "85a9692d-b994-4942-8dab-8e64b60911de",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 2,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "64e505de-bc1c-4de1-9707-4c8182529080",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "2ccb762f-8965-4f61-bbb0-69fff46c9a6d",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
} ]

책 이름이 포함되는 책 대여 목록 조회

HTTP request

GET /book-borrows?book-name=%EC%B1%85%EC%A0%9C%EB%AA%A9 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 334
Host: 223.255.205.62:30505

{
  "book" : {
    "isbn" : "9791188116065",
    "title" : "미움 받을 용기",
    "author" : "독도독도",
    "publisher" : "test_b64e856b1458",
    "imageUrl" : "http://aaa.bb.com",
    "price" : 62,
    "publishAt" : "2023-02-27"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1340

[ {
  "id" : 5,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "6e796cea-7deb-4bc2-908d-f08b290b3b9a",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "27e534fd-0c78-4886-9c88-42a337c9639a",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 4,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "d532825c-f09a-48d0-8da4-aacc8f489730",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "b82a1b70-d30f-4598-b228-df6f43d26e36",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 2,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "f0d9cf0f-ca34-48e6-b05b-d2a13004be49",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "7257d15f-07bc-4757-9566-61e8fbae1998",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
} ]

책 대여 신청

HTTP request

POST /book-borrows/1/borrow HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 204 No Content

책 반납

HTTP request

POST /book-borrows/1/return HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 204 No Content

내가 borrow한 도서 대여 목록 조회

HTTP request

GET /book-borrows/my-borrow HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1352

[ {
  "id" : 5,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "51b64b6c-21c3-4040-bee4-0e5fa76ac640",
    "name" : "대출자"
  },
  "borrower" : {
    "id" : "24af9a0f-1cdd-4338-babe-c532e6513f78",
    "name" : "빌린 사람"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 4,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "640c3a57-c31e-41bf-8472-379f102ae39f",
    "name" : "대출자"
  },
  "borrower" : {
    "id" : "24af9a0f-1cdd-4338-babe-c532e6513f78",
    "name" : "빌린 사람"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 2,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "f44574ad-e938-4bf3-bc36-a86c8a458c29",
    "name" : "대출자"
  },
  "borrower" : {
    "id" : "24af9a0f-1cdd-4338-babe-c532e6513f78",
    "name" : "빌린 사람"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
} ]

내가 lend한 도서 목록 조회

HTTP request

GET /book-borrows/my-lend HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 1340

[ {
  "id" : 5,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "f06b2097-b33c-479c-8274-105155e3309f",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "5cf13513-d015-4dfb-816e-100be8ff1c71",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 4,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "f06b2097-b33c-479c-8274-105155e3309f",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "3e67a526-b0e4-431e-a3bd-4b2dc49639e6",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
}, {
  "id" : 2,
  "book" : {
    "id" : 5,
    "title" : "책제목",
    "author" : "작가",
    "publisher" : "출판사",
    "imageUrl" : "책이미지"
  },
  "lender" : {
    "id" : "f06b2097-b33c-479c-8274-105155e3309f",
    "name" : "작성자"
  },
  "borrower" : {
    "id" : "1ab9f914-755f-4102-8ba8-eb62de950527",
    "name" : "대여자"
  },
  "location" : "인천",
  "endDate" : "2023-02-27",
  "kakaoUrl" : "http://aaa.bb.com"
} ]

Member

유저 정보 업데이트

HTTP request

PUT /members HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 393
Host: 223.255.205.62:30505

{
  "name" : "test_76ca4ff20751",
  "blogUrl" : "test_0053924831c5",
  "githubId" : "test_ad40e3ba2f88",
  "academicStatus" : "ATTEND",
  "major" : "COMPUTER",
  "subMajor" : "MEDIA_DESIGN",
  "email" : "test_66614058107f",
  "grade" : 1,
  "studentId" : "test_413294765eab",
  "phoneNumber" : "test_413294765eab",
  "profileUrl" : "test_edabe30dee71",
  "introduction" : "test_f958a7f1746b"
}

HTTP response

HTTP/1.1 204 No Content

유저 전체 목록 가져오기

HTTP request

GET /members HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 707

[ {
  "id" : "a3e927ec-799d-40b3-94c4-560462607ce1",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "profileUrl" : "profile"
}, {
  "id" : "2e5972b9-b8ee-40e8-b91a-2c2d7e4409fc",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "profileUrl" : "profile"
}, {
  "id" : "fcca7390-92d4-4f77-9e60-2e94919aeb0b",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "profileUrl" : "profile"
}, {
  "id" : "e59a98e9-6ee0-4f04-b83c-e71c511d6bd4",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "profileUrl" : "profile"
}, {
  "id" : "333dc88f-8df1-44ba-babc-2b552e19996f",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "profileUrl" : "profile"
} ]

유저 단일 조회

HTTP request

GET /members/23722509-33e2-4e9e-8c00-45fad8d41e77 HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 273

{
  "id" : "f4f939d7-bd6c-44ca-a54a-f698fa7f984c",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "email" : "email.ac.com",
  "blogUrl" : "http://blog.com",
  "githubId" : "phjppo0918",
  "profileUrl" : "자기소개입니다",
  "introduction" : "profile"
}

유저 개인 정보 포함 조회

HTTP request

GET /members/c041ee77-01f2-47f0-ade8-9e5cb544b551/privacy HTTP/1.1
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 338

{
  "id" : "ff370c30-2459-4520-828b-26ae41fca7af",
  "name" : "이름",
  "grade" : 2,
  "major" : "COMPUTER",
  "email" : "email.ac.com",
  "blogUrl" : "http://blog.com",
  "githubId" : "phjppo0918",
  "introduction" : "자기소개입니다",
  "profileUrl" : "profile",
  "studentId" : "2018314014",
  "phoneNumber" : "010-0000-1234"
}

Study Group

스터디 그룹 생성

HTTP request

POST /study-groups HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 321
Host: 223.255.205.62:30505

{
  "name" : "봄나물",
  "description" : "스프링 기초 스터디 핵심원리편",
  "leader" : "e09ccc96-349d-472a-8aa9-8ad29a65da8e",
  "members" : [ "b05f247b-cf39-487d-8470-f50337f0c1e7", "4668cf31-7081-4368-a30a-16ff9e2bf791", "6609ccbf-a7e9-4bed-b748-4529df21b02b", "26994ad0-e8a7-4250-8f6d-de48b086d441" ]
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 14

{
  "id" : 1
}

스터디 그룹 수정

HTTP request

PUT /study-groups/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 321
Host: 223.255.205.62:30505

{
  "name" : "봄나물",
  "description" : "스프링 기초 스터디 핵심원리편",
  "leader" : "e09ccc96-349d-472a-8aa9-8ad29a65da8e",
  "members" : [ "b05f247b-cf39-487d-8470-f50337f0c1e7", "4668cf31-7081-4368-a30a-16ff9e2bf791", "6609ccbf-a7e9-4bed-b748-4529df21b02b", "26994ad0-e8a7-4250-8f6d-de48b086d441" ]
}

HTTP response

HTTP/1.1 200 OK

스터디 그룹 좋아요 추가

HTTP request

POST /study-groups/1/like-count/add HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 그룹 좋아요 취소

HTTP request

POST /study-groups/1/like-count/cancel HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 종료

HTTP request

POST /study-groups/1/finish HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 삭제

HTTP request

DELETE /study-groups/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 그룹 상세 조회

HTTP request

GET /study-groups/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 420

{
  "name" : "자바칩 스터디",
  "description" : "자바칩 정복 스터디입니다",
  "likeCount" : 100,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "a941fc61-f36a-4b2b-a599-2b1787df87a0",
    "name" : "리더"
  },
  "members" : [ {
    "id" : "d80d68e4-48ca-4b4a-af1f-ab00e7d0c4b9",
    "name" : "멤버2"
  }, {
    "id" : "8d197ff0-1347-4408-892a-aef0c1b5af6a",
    "name" : "멤버1"
  } ]
}

스터디 그룹 최신순 조회

HTTP request

GET /study-groups?page=0&size=20&sort=createdAt,DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 847

[ {
  "name" : "자바칩 스터디",
  "description" : "자바칩 정복 스터디입니다",
  "likeCount" : 100,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "a941fc61-f36a-4b2b-a599-2b1787df87a0",
    "name" : "리더"
  },
  "members" : [ {
    "id" : "d80d68e4-48ca-4b4a-af1f-ab00e7d0c4b9",
    "name" : "멤버2"
  }, {
    "id" : "8d197ff0-1347-4408-892a-aef0c1b5af6a",
    "name" : "멤버1"
  } ]
}, {
  "name" : "쿠버네티스 스터디",
  "description" : "도커는 배우고 오세요",
  "likeCount" : 50,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "21ce804f-1406-439a-8d96-113cfbdbb80d",
    "name" : "leader"
  },
  "members" : [ {
    "id" : "b31daba1-86e9-4055-bceb-f798a8d21aed",
    "name" : "멤버22"
  }, {
    "id" : "424e6ce2-70d8-44af-9d3f-42f38a8a7f25",
    "name" : "멤버11"
  } ]
} ]

스터디 그룹 좋아요순 조회

HTTP request

GET /study-groups?page=0&size=20&sort=numOfLike,DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 847

[ {
  "name" : "자바칩 스터디",
  "description" : "자바칩 정복 스터디입니다",
  "likeCount" : 100,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "a941fc61-f36a-4b2b-a599-2b1787df87a0",
    "name" : "리더"
  },
  "members" : [ {
    "id" : "d80d68e4-48ca-4b4a-af1f-ab00e7d0c4b9",
    "name" : "멤버2"
  }, {
    "id" : "8d197ff0-1347-4408-892a-aef0c1b5af6a",
    "name" : "멤버1"
  } ]
}, {
  "name" : "쿠버네티스 스터디",
  "description" : "도커는 배우고 오세요",
  "likeCount" : 50,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "21ce804f-1406-439a-8d96-113cfbdbb80d",
    "name" : "leader"
  },
  "members" : [ {
    "id" : "b31daba1-86e9-4055-bceb-f798a8d21aed",
    "name" : "멤버22"
  }, {
    "id" : "424e6ce2-70d8-44af-9d3f-42f38a8a7f25",
    "name" : "멤버11"
  } ]
} ]

스터디 그룹 일지개수순 조회

HTTP request

GET /study-groups?page=0&size=20&sort=numOfStudyActivity,DESC HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 847

[ {
  "name" : "자바칩 스터디",
  "description" : "자바칩 정복 스터디입니다",
  "likeCount" : 100,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "a941fc61-f36a-4b2b-a599-2b1787df87a0",
    "name" : "리더"
  },
  "members" : [ {
    "id" : "d80d68e4-48ca-4b4a-af1f-ab00e7d0c4b9",
    "name" : "멤버2"
  }, {
    "id" : "8d197ff0-1347-4408-892a-aef0c1b5af6a",
    "name" : "멤버1"
  } ]
}, {
  "name" : "쿠버네티스 스터디",
  "description" : "도커는 배우고 오세요",
  "likeCount" : 50,
  "studyGroupStatus" : "ACTIVE",
  "leader" : {
    "id" : "21ce804f-1406-439a-8d96-113cfbdbb80d",
    "name" : "leader"
  },
  "members" : [ {
    "id" : "b31daba1-86e9-4055-bceb-f798a8d21aed",
    "name" : "멤버22"
  }, {
    "id" : "424e6ce2-70d8-44af-9d3f-42f38a8a7f25",
    "name" : "멤버11"
  } ]
} ]

Study Activity

스터디 일지 생성

HTTP request

POST /study-activities HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 443
Host: 223.255.205.62:30505

{
  "title" : "자바 스터디 1일차",
  "description" : "자바 기본 문법",
  "assignment" : "1단원 연습 문제",
  "week" : 1,
  "place" : "보보스 1호점",
  "activityMembers" : [ "a6b83fc0-085c-4f69-a0a7-04874acd5cbe", "20dbac61-42e8-42d8-90a2-008af43fa985", "05961ae1-94c7-480a-a17a-505c345aaa57" ],
  "studyGroupId" : 1,
  "studyTime" : {
    "startTime" : "2023-02-27T09:35:32",
    "endTime" : "2023-02-27T11:35:32"
  }
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 14

{
  "id" : 1
}

스터디 일지 수정

HTTP request

PUT /study-activities/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 443
Host: 223.255.205.62:30505

{
  "title" : "자바 스터디 1일차",
  "description" : "자바 기본 문법",
  "assignment" : "1단원 연습 문제",
  "week" : 1,
  "place" : "보보스 1호점",
  "activityMembers" : [ "a6b83fc0-085c-4f69-a0a7-04874acd5cbe", "20dbac61-42e8-42d8-90a2-008af43fa985", "05961ae1-94c7-480a-a17a-505c345aaa57" ],
  "studyGroupId" : 1,
  "studyTime" : {
    "startTime" : "2023-02-27T09:35:32",
    "endTime" : "2023-02-27T11:35:32"
  }
}

HTTP response

HTTP/1.1 200 OK

스터디 일지 삭제

HTTP request

DELETE /study-activities/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 일지 단일 조회

HTTP request

GET /study-activities/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 476

{
  "title" : "k8s 스터디",
  "description" : "K8S아니고 KBS",
  "assignment" : "과제1",
  "week" : 4,
  "place" : "종합관 2층 스터디룸",
  "studyTime" : {
    "startDate" : "2023-02-27",
    "startTime" : "09:35:32",
    "endDate" : "2023-02-27",
    "endTime" : "11:35:32"
  },
  "activityMembers" : [ {
    "id" : "23c2d655-6ad1-418d-9c2c-6e04fcd7c8c6",
    "name" : "Lee"
  }, {
    "id" : "67c35b77-e6a2-46b2-a299-cc8abfd29cbb",
    "name" : "Kim"
  } ]
}

스터디그룹 별 스터디 일지 리스트 조회

HTTP request

GET /study-activities?studyGroup=1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 966

[ {
  "title" : "k8s 스터디",
  "description" : "K8S아니고 KBS",
  "assignment" : "과제1",
  "week" : 4,
  "place" : "종합관 2층 스터디룸",
  "studyTime" : {
    "startDate" : "2023-02-27",
    "startTime" : "09:35:32",
    "endDate" : "2023-02-27",
    "endTime" : "11:35:32"
  },
  "activityMembers" : [ {
    "id" : "23c2d655-6ad1-418d-9c2c-6e04fcd7c8c6",
    "name" : "Lee"
  }, {
    "id" : "67c35b77-e6a2-46b2-a299-cc8abfd29cbb",
    "name" : "Kim"
  } ]
}, {
  "title" : "리액트 스터디",
  "description" : "React.js",
  "assignment" : "타입스크립트 조사해오기",
  "week" : 1,
  "place" : "E동2층",
  "studyTime" : {
    "startDate" : "2023-02-27",
    "startTime" : "09:35:32",
    "endDate" : "2023-02-27",
    "endTime" : "11:35:32"
  },
  "activityMembers" : [ {
    "id" : "6e197c76-6d78-4697-a197-1c6015a59f81",
    "name" : "Hong"
  }, {
    "id" : "a5032ce3-8663-4f07-8aaf-5c7eaa55df71",
    "name" : "Park"
  } ]
} ]

Study Plan

스터디 계획서 생성

HTTP request

POST /study-plans HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 171
Host: 223.255.205.62:30505

{
  "title" : "스프링가링가링 스터디 계획서",
  "studyRule" : "튀면 벌금 50000원",
  "weekPlan" : "1 ~ 10주차 스프링 공부",
  "studyGroupId" : 1
}

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 14

{
  "id" : 1
}

스터디 계획서 수정

HTTP request

PUT /study-plans/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Content-Length: 171
Host: 223.255.205.62:30505

{
  "title" : "스프링가링가링 스터디 계획서",
  "studyRule" : "튀면 벌금 50000원",
  "weekPlan" : "1 ~ 10주차 스프링 공부",
  "studyGroupId" : 1
}

HTTP response

HTTP/1.1 200 OK

스터디 계획서 삭제

HTTP request

DELETE /study-plans/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK

스터디 계획서 조회

HTTP request

GET /study-plans/1 HTTP/1.1
Content-Type: application/json;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 172

{
  "id" : 1,
  "title" : "자바 스터디 계획서",
  "studyRule" : "매주 과제 열심히 안해올 시 커피 쏘기",
  "weekPlan" : "1 ~ 12주차 자바 공부"
}

File

파일 업로드

HTTP request

POST /files HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8
Content-Length: 38
Host: 223.255.205.62:30505

"파일을 Request시 넣어주세요"

HTTP response

HTTP/1.1 200 OK
Content-Type: application/json;charset=UTF-8
Content-Length: 146

{
  "id" : 1,
  "filename" : "plan.docx",
  "downloadUri" : "http://localhost:8080/api/v1/files/1",
  "contentType" : "docx",
  "fileSize" : 100
}

파일 다운로드

HTTP request

GET /files/1 HTTP/1.1
Content-Type: multipart/form-data;charset=UTF-8
Host: 223.255.205.62:30505

HTTP response

HTTP/1.1 200 OK
Content-Type: multipart/form-data;charset=UTF-8
Content-Disposition: attachment; filename*=UTF-8''file.docx
Accept-Ranges: bytes
Content-Length: 1