Member
Join Member
Request
POST /api/member/join/student HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 272
Host: localhost:8080
{
"username" : "test40",
"password" : "tkddnjs4371@",
"passwordConfirm" : "tkddnjs4371@",
"name" : "최상원",
"email" : "test40@naver.com",
"nickname" : "test40",
"year" : "1997",
"month" : "02",
"day" : "12",
"subject" : [ "CHEMISTRY", "BIOLOGY" ]
}
Request Fields
Path | Type | Description |
---|---|---|
|
|
사용자 아이디 |
|
|
사용자 비밀번호 |
|
|
사용자 비밀번호 확인 |
|
|
사용자 이름 |
|
|
사용자 이메일 |
|
|
사용자 닉네임 |
|
|
사용자 관심과목 |
|
|
사용자 출생년도 |
|
|
사용자 출생월 |
|
|
사용자 출생일 |
Request Path Parameter
Parameter | Description |
---|---|
|
스터디 url |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 12
Join Success
Check Email Valid
Request
GET /api/member/check-email-token?token=ae89ade4-1970-479f-8c60-600937cdfac2&email=test40@naver.com HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Request Parameter
Parameter | Description |
---|---|
|
이메일 인증토큰 |
|
인증해야할 이메일 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 18
Join Success Final
Check Email Valid
Request
POST /api/member/join/email-check HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 34
Host: localhost:8080
{
"email" : "test40@naver.com"
}
Request Field
Path | Type | Description |
---|---|---|
|
|
중복 확인하려는 사용자 이메일 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 14
Check Username
Check NickName Valid
Request
POST /api/member/join/nickname-check HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 32
Host: localhost:8080
{
"nickname" : "forest_choi"
}
Request Field
Path | Type | Description |
---|---|---|
|
|
중복 확인하려는 사용자 닉네임 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 14
Check Username
Check Username Valid
Request
POST /api/member/join/username-check HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 27
Host: localhost:8080
{
"username" : "test40"
}
Request Field
Path | Type | Description |
---|---|---|
|
|
중복 확인하려는 사용자 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 14
Check Username
Login
Request
POST /api/member/login HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 58
Host: localhost:8080
{
"username" : "test40",
"password" : "tkddnjs4371@"
}
Request Field
Path | Type | Description |
---|---|---|
|
|
사용자 아이디 |
|
|
사용자 비밀번호 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 435
{
"id" : 37,
"username" : "test40",
"accessToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2MzU4MzExNX0.V2pw_YS-H1B40HAKJJhO7wvUw1Lwps4rbc8KQTZvEIk46M9--5O6-oA8R_X_JQaPapbLSkEq5hFbawSzEU-SlQ",
"refreshToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2NDE3NzExNX0.fXPxeH86Whq-5bqUITSq34z3LBFR6hcg-u2B3tnxkiBFgUDPx53DvCJrCQXbmJ3fY3M6eikRH72ph851Jw4X8w"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
사용자 PK |
|
|
사용자 아이디 |
|
|
Access Token |
|
|
RefreshToken |
Logout
DELETE /api/member/logout HTTP/1.1
Content-Type: application/json
Accept: application/json
Username: test40
X-AUTH-TOKEN: Bearer eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTQsImV4cCI6MTY2MzU4MzExNH0.BeyG9GN3Y25A3ckDueGzDrDm6xK1Mb6jhnfSPCycrltcRWz72qbqYcauWAmXbdPUmBxQrUPNJa_L7ELTbpWnWA
Host: localhost:8080
Request Header
Name | Description |
---|---|
|
사용자 아이디 |
|
엑세스 토큰 |
Response
HTTP/1.1 200 OK
AccessToken Reissue
Request
POST /api/member/auth/token HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 397
Host: localhost:8080
{
"accessToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2MzU3MjMxNX0.7TKUW-d_tWbkDjefpqc6h-mGEJn_iJ1K9TsDHfv3Ovb88FesRBKrHn-ZtXcAUG1xEeNvkLI9v6gtwKo0n3GNPg",
"refreshToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2NDE3NzExNX0.fXPxeH86Whq-5bqUITSq34z3LBFR6hcg-u2B3tnxkiBFgUDPx53DvCJrCQXbmJ3fY3M6eikRH72ph851Jw4X8w"
}
Request Field
Path | Type | Description |
---|---|---|
|
|
만료된 엑세스 토큰 |
|
|
만료되지않는 리프레시 토큰 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 397
{
"accessToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2MzU4MzExNX0.V2pw_YS-H1B40HAKJJhO7wvUw1Lwps4rbc8KQTZvEIk46M9--5O6-oA8R_X_JQaPapbLSkEq5hFbawSzEU-SlQ",
"refreshToken" : "eyJhbGciOiJIUzUxMiJ9.eyJzdWIiOiJ0ZXN0NDAiLCJpYXQiOjE2NjM1NzIzMTUsImV4cCI6MTY2NDE3NzExNX0.fXPxeH86Whq-5bqUITSq34z3LBFR6hcg-u2B3tnxkiBFgUDPx53DvCJrCQXbmJ3fY3M6eikRH72ph851Jw4X8w"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
새로운 엑세스 토큰 |
|
|
기존 리프레시 토큰 |
AdminPost
AdminPost-Create
Request
$ curl 'http://localhost:8080/api/admin/notice/new' -i -X POST \
-H 'Content-Type: multipart/form-data;charset=UTF-8' \
-H 'Accept: application/json' \
-F 'postSaveRequestDto=@postSaveRequestDto;type=application/json' \
-F 'file=@file.png;type=image/png'
Request Part
Part | Description |
---|---|
|
업로드 하고싶은 파일 |
|
제목, 내용 |
Request Path Parameter
Parameter | Description |
---|---|
|
관리자 게시판 카테고리 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 13
Notice Create
AdminPost-Update
Request
$ curl 'http://localhost:8080/api/admin/notice/29' -i -X POST \
-H 'Content-Type: multipart/form-data;charset=UTF-8' \
-H 'Accept: application/json' \
-F 'postUpdateRequestDto=@postUpdateRequestDto;type=application/json' \
-F 'file=@file.png;type=image/png'
Request Part
Part | Description |
---|---|
|
업로드 하고싶은 파일 |
|
제목, 내용 |
Request Path Parameter
Parameter | Description |
---|---|
|
관리자 게시판 카테고리 |
|
수정하려는 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 13
Notice Update
AdminPost-Delete
Request
$ curl 'http://localhost:8080/api/admin' -i -X DELETE \
-H 'Content-Type: application/json' \
-H 'Post: notice' \
-H 'Post-Id: 28' \
-H 'Accept: application/json'
Request Header
Name | Description |
---|---|
|
관리자 게시판 카테고리 |
|
삭제하려는 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 13
Notice Delete
AdminPost-Info
Request
GET /api/admin/notice/25 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Request Path Parameter
Parameter | Description |
---|---|
|
관리자 게시판 카테고리 |
|
조회하려는 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 148
{
"postId" : 25,
"title" : "test",
"content" : "test",
"author" : "숲속의냉면",
"files" : [ ],
"commentInfoResponseDtoList" : [ ]
}
Response Field
Path | Type | Description |
---|---|---|
|
|
조회한 게시글 아이디 |
|
|
조회한 게시글 제목 |
|
|
조회한 게시글 내용 |
|
|
조회한 게시글 작성자 |
|
|
조회한 게시글 첨부파일 |
|
|
조회한 게시글 댓글들 |
AdminPost-List
Request
GET /api/admin/notice?title=&content= HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Request Parameter
Parameter | Description |
---|---|
|
검색하려는 게시글 제목 : Null허용 |
|
검색하려는 게시글 내용 : Null허용 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1835
{
"totalPageCount" : 1,
"currentPageNum" : 0,
"totalElementCount" : 11,
"currentPageElementCount" : 11,
"simplePostDtoList" : [ {
"postId" : 26,
"title" : "test",
"content" : "test",
"author" : "숲속의냉면",
"createdDate" : "2022-09-19T16:25:18.416475"
}, {
"postId" : 10,
"title" : "title10",
"content" : "content10",
"author" : "nickname4",
"createdDate" : "2022-09-19T16:25:01.721139"
}, {
"postId" : 9,
"title" : "title9",
"content" : "content9",
"author" : "nickname4",
"createdDate" : "2022-09-19T16:25:01.716050"
}, {
"postId" : 8,
"title" : "title8",
"content" : "content8",
"author" : "nickname2",
"createdDate" : "2022-09-19T16:25:01.712701"
}, {
"postId" : 7,
"title" : "title7",
"content" : "content7",
"author" : "nickname5",
"createdDate" : "2022-09-19T16:25:01.710750"
}, {
"postId" : 6,
"title" : "title6",
"content" : "content6",
"author" : "nickname3",
"createdDate" : "2022-09-19T16:25:01.708228"
}, {
"postId" : 5,
"title" : "title5",
"content" : "content5",
"author" : "nickname4",
"createdDate" : "2022-09-19T16:25:01.703"
}, {
"postId" : 4,
"title" : "title4",
"content" : "content4",
"author" : "nickname1",
"createdDate" : "2022-09-19T16:25:01.699388"
}, {
"postId" : 3,
"title" : "title3",
"content" : "content3",
"author" : "nickname5",
"createdDate" : "2022-09-19T16:25:01.694002"
}, {
"postId" : 2,
"title" : "title2",
"content" : "content2",
"author" : "nickname5",
"createdDate" : "2022-09-19T16:25:01.689564"
}, {
"postId" : 1,
"title" : "title1",
"content" : "content1",
"author" : "nickname2",
"createdDate" : "2022-09-19T16:25:01.677490"
} ]
}
Response Field
Path | Type | Description |
---|---|---|
|
|
전체 페이지 수 |
|
|
현재 페이지 번호 |
|
|
전체 게시글 갯수 |
|
|
현재 페이지에 존재하는 게시글 수 |
|
|
간단한 게시글 정보 |
|
|
게시글 아이디 |
|
|
게시글 제목 |
|
|
게시글 내용 |
|
|
게시글 작성자 |
|
|
게시글 생성시간 |
StudyPost
StudyPost-Create
Request
$ curl 'http://localhost:8080/api/study/test/post/homework' -i -X POST \
-H 'Content-Type: multipart/form-data;charset=UTF-8' \
-H 'Accept: application/json' \
-F 'postSaveRequestDto=@postSaveRequestDto;type=application/json' \
-F 'file=@file.png;type=image/png'
Request Part
Part | Description |
---|---|
|
업로드 하고싶은 파일 |
|
제목, 내용 |
Request Path Parameter
Parameter | Description |
---|---|
|
스터디 고유 주소 |
|
스터디 게시판 카테고리 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 181
{
"response" : {
"title" : "studyPost",
"content" : "studyPost",
"author" : "swchoi1997",
"files" : [ ],
"postEnum" : "STUDY_HOMEWORK"
},
"status" : "OK"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
응답 내용 |
|
|
제목 |
|
|
내용 |
|
|
작성자 |
|
|
첨부파일 |
|
|
카테고리 |
|
|
상태코드 |
StudyPost-Update
Request
$ curl 'http://localhost:8080/api/study/test/post/homework/2' -i -X POST \
-H 'Content-Type: multipart/form-data;charset=UTF-8' \
-H 'Accept: application/json' \
-F 'postUpdateRequestDto={
"title": "test123",
"content": "test123"
};type=application/json' \
-F 'file=@file.png;type=image/png'
Request Part
Part | Description |
---|---|
|
업로드 하고싶은 파일 |
|
제목, 내용 |
Request Path Parameter
Parameter | Description |
---|---|
|
스터디 고유 주소 |
|
스터디 게시판 카테고리 |
|
스터디 게시판 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 177
{
"response" : {
"title" : "test123",
"content" : "test123",
"author" : "swchoi1997",
"files" : [ ],
"postEnum" : "STUDY_HOMEWORK"
},
"status" : "OK"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
응답 내용 |
|
|
제목 |
|
|
내용 |
|
|
작성자 |
|
|
첨부파일 |
|
|
카테고리 |
|
|
상태코드 |
StudyPost-Delete
Request
$ curl 'http://localhost:8080/api/study/test/post/homework' -i -X DELETE \
-H 'Content-Type: application/json' \
-H 'Post-Id: 1' \
-H 'Accept: application/json'
Request Header
Name | Description |
---|---|
|
삭제하려는 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 78
{"headers":{},"body":"delete success","statusCodeValue":200,"statusCode":"OK"}
StudyPost-Info
Request
GET /api/study/test/post/homework/3 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Request Path Parameter
Parameter | Description |
---|---|
|
스터디 고유 주소 |
|
스터디 게시판 카테고리 |
|
조회하려는 게시글 아이디 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 199
{
"response" : {
"postId" : 3,
"title" : "test",
"content" : "test",
"author" : "숲속의냉면",
"files" : [ ],
"commentInfoResponseDtoList" : [ ]
},
"status" : "OK"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
응답 내용 |
|
|
조회한 게시글 아이디 |
|
|
조회한 게시글 제목 |
|
|
조회한 게시글 내용 |
|
|
조회한 게시글 작성자 |
|
|
조회한 게시글 첨부파일 |
|
|
조회한 게시글 댓글들 |
|
|
상태코드 |
StudyPost-List
Request
GET /api/study/test/post/homework?title=&content= HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
Request Parameter
Parameter | Description |
---|---|
|
검색하려는 게시글 제목 : Null허용 |
|
검색하려는 게시글 내용 : Null허용 |
Response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 354
{
"response" : {
"totalPageCount" : 1,
"currentPageNum" : 0,
"totalElementCount" : 1,
"currentPageElementCount" : 1,
"simplePostDtoList" : [ {
"postId" : 4,
"title" : "test",
"content" : "test",
"author" : "숲속의냉면",
"createdDate" : "2022-09-19T16:25:20.117579"
} ]
},
"status" : "OK"
}
Response Field
Path | Type | Description |
---|---|---|
|
|
응답 내용 |
|
|
전체 페이지 수 |
|
|
현재 페이지 번호 |
|
|
전체 게시글 갯수 |
|
|
현재 페이지에 존재하는 게시글 수 |
|
|
간단한 게시글 정보 |
|
|
게시글 아이디 |
|
|
게시글 제목 |
|
|
게시글 내용 |
|
|
게시글 작성자 |
|
|
게시글 생성시간 |
|
|
상태코드 |
Profile
update profile
request
PUT /api/profile HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 146
Host: localhost:8080
{
"nickname" : "test nickname",
"bio" : "test bio",
"profileImageUrl" : "test profile image",
"subjectList" : [ "ENGLISH", "CHEMISTRY" ]
}
request fields
Path | Type | Description |
---|---|---|
|
|
회원의 nickname |
|
|
회원의 자기소개 |
|
|
회원의 profile Image |
|
|
회원의 subject List |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 9
update Ok
get profile
request
GET /api/profile/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
request path parameters
Parameter | Description |
---|---|
|
profile의 id |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 216
{
"username" : "test username",
"email" : "test@godtudy.com",
"nickname" : "test nickname",
"bio" : "test bio",
"profileImageUrl" : "test profile image",
"subjectList" : [ "BIOLOGY", "KOREAN_LANGUAGE" ]
}
response fields
Path | Type | Description |
---|---|---|
|
|
회원의 username |
|
|
회원의 email |
|
|
회원의 nickname |
|
|
회원의 소개말 |
|
|
회원의 profileImageUrl |
|
|
회원의 subjectList |
get profile list
request
GET /api/profile/list?username=&role=STUDENT&name= HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
request parameters
Parameter | Description |
---|---|
|
username |
|
name |
|
role |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 370
{
"totalPageCount" : 1,
"currentPageNumber" : 0,
"totalElementCount" : 1,
"currentPageElementCount" : 1,
"profileDtoList" : [ {
"username" : "test username",
"email" : "test@godtudy.com",
"nickname" : "test nickname",
"bio" : "test bio",
"profileImageUrl" : "test profile image",
"subjectList" : [ "BIOLOGY", "KOREAN_LANGUAGE" ]
} ]
}
response fields
Path | Type | Description |
---|---|---|
|
|
회원의 username |
|
|
회원의 email |
|
|
회원의 nickname |
|
|
회원의 소개말 |
|
|
회원의 profileImageUrl |
|
|
회원의 subjectList |
password update
request
POST /api/profile/password HTTP/1.1
Content-Type: application/json
X-AUTH-TOKEN: jwtToken
Accept: application/json
Content-Length: 79
Host: localhost:8080
{
"newPassword" : "newpassword1@",
"newPasswordConfirm" : "newpassword1@"
}
request header
Name | Description |
---|---|
|
access token |
request body
{
"newPassword" : "newpassword1@",
"newPasswordConfirm" : "newpassword1@"
}
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 15
Password Update
Study
create study
request
POST /api/study HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 171
Host: localhost:8080
{
"name" : "국어",
"teacherId" : 1,
"studentId" : 2,
"url" : "korean-study",
"subject" : "국어",
"shortDescription" : "국어 문법 스터디 입니다"
}
request fields
Path | Type | Description |
---|---|---|
|
|
이름 |
|
|
스터디 url |
|
|
과목 |
|
|
스터디 소개 |
|
|
선생님 id |
|
|
학생 id |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 345
{
"name" : "국어 스터디",
"url" : "korean-study",
"subject" : "국어",
"teacher" : {
"id" : 1,
"name" : "선생님 name",
"username" : "선생님 username"
},
"student" : {
"id" : 2,
"name" : "학생 name",
"username" : "학생 username"
},
"shortDescription" : "국어 문법 스터디 입니다"
}
response fields
Path | Type | Description |
---|---|---|
|
|
이름 |
|
|
스터디 url |
|
|
과목 |
|
|
스터디 소개 |
|
|
선생님 ID |
|
|
선생님 이름 |
|
|
선생님 닉네임 |
|
|
학생 ID |
|
|
학생 이름 |
|
|
학생 닉네임 |
update study
request
PUT /api/study/korean-study HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 126
Host: localhost:8080
{
"name" : "국어 스터디",
"shortDescription" : "국어 문법 스터디에서 다른 스터디로 변경할게요!"
}
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
request fields
Path | Type | Description |
---|---|---|
|
|
스터디 이름 |
|
|
스터디 소개 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 345
{
"name" : "국어 스터디",
"url" : "korean-study",
"subject" : "국어",
"teacher" : {
"id" : 1,
"name" : "선생님 name",
"username" : "선생님 username"
},
"student" : {
"id" : 2,
"name" : "학생 name",
"username" : "학생 username"
},
"shortDescription" : "국어 문법 스터디입니다."
}
response fields
Path | Type | Description |
---|---|---|
|
|
이름 |
|
|
스터디 url |
|
|
과목 |
|
|
스터디 소개 |
|
|
선생님 ID |
|
|
선생님 이름 |
|
|
선생님 닉네임 |
|
|
학생 ID |
|
|
학생 이름 |
|
|
학생 닉네임 |
get study
request
GET /api/study/korean-study HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 345
{
"name" : "국어 스터디",
"url" : "korean-study",
"subject" : "국어",
"teacher" : {
"id" : 1,
"name" : "선생님 name",
"username" : "선생님 username"
},
"student" : {
"id" : 2,
"name" : "학생 name",
"username" : "학생 username"
},
"shortDescription" : "국어 문법 스터디입니다."
}
response fields
Path | Type | Description |
---|---|---|
|
|
이름 |
|
|
스터디 url |
|
|
과목 |
|
|
스터디 소개 |
|
|
선생님 ID |
|
|
선생님 이름 |
|
|
선생님 닉네임 |
|
|
학생 ID |
|
|
학생 이름 |
|
|
학생 닉네임 |
delete study
request
DELETE /api/study HTTP/1.1
Content-Type: application/json
Study-Url: korean-study
Accept: application/json
Host: localhost:8080
request headers
Name | Description |
---|---|
|
스터디 url |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 12
korean-study
Todo
create todo
request
POST /api/study/new-study/todo HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 95
Host: localhost:8080
{
"title" : "todo title",
"content" : "todo content",
"endDate" : "1997-02-12T00:00:00"
}
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
request fields
Path | Type | Description |
---|---|---|
|
|
todo 제목 |
|
|
todo 내용 |
|
|
마감기한 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 135
{
"id" : 1,
"title" : "todo title",
"content" : "todo content",
"endDate" : [ 2020, 2, 12, 0, 0 ],
"studyUrl" : "study Url"
}
response fields
Path | Type | Description |
---|---|---|
|
|
todo id |
|
|
todo 제목 |
|
|
todo 내용 |
|
|
todo 마감기한 |
|
|
스터디 url |
update todo
request
PUT /api/study/new-study/todo/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 113
Host: localhost:8080
{
"title" : "todo title - 수정",
"content" : "todo content - 수정",
"endDate" : "1997-02-12T00:00:00"
}
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
|
todo id |
request fields
Path | Type | Description |
---|---|---|
|
|
todo 제목 |
|
|
todo 내용 |
|
|
마감기한 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 135
{
"id" : 1,
"title" : "todo title",
"content" : "todo content",
"endDate" : [ 2020, 2, 12, 0, 0 ],
"studyUrl" : "study Url"
}
response fields
Path | Type | Description |
---|---|---|
|
|
todo id |
|
|
todo 제목 |
|
|
todo 내용 |
|
|
todo 마감기한 |
|
|
스터디 url |
get todo
request
GET /api/study/new-study/todo/1 HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
|
todo id |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 135
{
"id" : 1,
"title" : "todo title",
"content" : "todo content",
"endDate" : [ 2020, 2, 12, 0, 0 ],
"studyUrl" : "study Url"
}
response fields
Path | Type | Description |
---|---|---|
|
|
todo id |
|
|
todo 제목 |
|
|
todo 내용 |
|
|
todo 마감기한 |
|
|
스터디 url |
get todo list
request
GET /api/study/new-study/todo HTTP/1.1
Content-Type: application/json
Accept: application/json
Host: localhost:8080
request path parameters
Parameter | Description |
---|---|
|
스터디 url |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 284
{
"totalPageCount" : 1,
"currentPageNumber" : 0,
"totalElementCount" : 1,
"currentPageElementCount" : 1,
"todoDtoList" : [ {
"id" : 1,
"title" : "todo title",
"content" : "todo content",
"endDate" : [ 2020, 2, 12, 0, 0 ],
"studyUrl" : "study Url"
} ]
}
response fields
Path | Type | Description |
---|---|---|
|
|
전체 page의 수 |
|
|
현재 page의 수 |
|
|
전체 content의 개수 |
|
|
한 페이지당 content의 개수 |
|
|
todo id |
|
|
todo 제목 |
|
|
todo 내용 |
|
|
todo 마감기한 |
|
|
스터디 url |
delete todo
request
DELETE /api/study/new-study/todo HTTP/1.1
Content-Type: application/json
Todo-Id: 1
Accept: application/json
Host: localhost:8080
request headers
Name | Description |
---|---|
|
todo id |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 1
1
Comment
create comment
request
POST /api/comment/notice/11/new HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 27
Host: localhost:8080
{
"content" : "test123"
}
request path parameters
Parameter | Description |
---|---|
|
게시물 카테고리 |
|
댓글을 작성하려는 게시물 아이디 |
request fields
Path | Type | Description |
---|---|---|
|
|
댓글 내용 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 175
{
"response" : {
"id" : 111,
"content" : "test123",
"username" : "swchoi1997",
"postKind" : "notice",
"message" : "Comment Save"
},
"status" : "OK"
}
response fields
Path | Type | Description |
---|---|---|
|
|
응답내용 |
|
|
댓글 아이디 |
|
|
댓글 작성자 아이디 |
|
|
댓글 내용 |
|
|
해당 댓글이 있는 게시물의 카테고리 |
|
|
응답 메세지 |
|
|
상태코드 |
create child comment
request
POST /api/comment/notice/12/112/new HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 27
Host: localhost:8080
{
"content" : "test123"
}
request path parameters
Parameter | Description |
---|---|
|
게시물 카테고리 |
|
댓글을 작성하려는 게시물 아이디 |
|
부모 댓글 아이디 |
request fields
Path | Type | Description |
---|---|---|
|
|
댓글 내용 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 177
{
"response" : {
"id" : 113,
"content" : "test123",
"username" : "swchoi1997",
"postKind" : "notice",
"message" : "ReComment Save"
},
"status" : "OK"
}
response fields
Path | Type | Description |
---|---|---|
|
|
응답내용 |
|
|
댓글 아이디 |
|
|
댓글 작성자 아이디 |
|
|
댓글 내용 |
|
|
해당 댓글이 있는 게시물의 카테고리 |
|
|
응답 메세지 |
|
|
상태코드 |
update comment
request
POST /api/comment/notice/13/114 HTTP/1.1
Content-Type: application/json
Accept: application/json
Content-Length: 27
Host: localhost:8080
{
"content" : "test321"
}
request path parameters
Parameter | Description |
---|---|
|
게시물 카테고리 |
|
댓글을 작성하려는 게시물 아이디 |
|
댓글 아이디 |
request fields
Path | Type | Description |
---|---|---|
|
|
댓글 내용 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 178
{
"response" : {
"id" : 114,
"content" : "test321",
"username" : "swchoi1997",
"postKind" : "notice",
"message" : "update Complete"
},
"status" : "OK"
}
response fields
Path | Type | Description |
---|---|---|
|
|
응답내용 |
|
|
댓글 아이디 |
|
|
댓글 작성자 아이디 |
|
|
댓글 내용 |
|
|
해당 댓글이 있는 게시물의 카테고리 |
|
|
응답 메세지 |
|
|
상태코드 |
delete comment
request
DELETE /api/comment/notice HTTP/1.1
Content-Type: application/json
Post-Id: 14
Comment-Id: 115
Accept: application/json
Host: localhost:8080
request path parameters
Parameter | Description |
---|---|
|
해당 댓글이 존재하는 게시글의 카테고리 |
request headers
Name | Description |
---|---|
|
해당 댓글이 존재하는 게시글 아이디 |
|
해당 댓글 아이디 |
response
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 15
Delete Complete