API 명세 이모지 의미
엔드 포인트 (Endpoint)
•
Method: GET
•
URL: /user/{userToken}/comments
요청 파라미터 (Request Parameters)
Parameter | Type | Required | Description |
userToken | String | Yes | 조회할 유저 식별을 위한 토큰 (id의 String 버전) |
page | Integer | No | 페이지 번호 (기본값: 0) |
size | Integer | No | 한 페이지당 게시글 수 (기본값: 3) |
헤더 정보 (Headers)
Header | Description |
Authorization | Bearer {token} |
Content-Type | application/json |
요청 예시 (Request Example)
•
요청
GET /user/{userToken}/comments?page=0&size=10
Content-Type: application/json
Authorization: Bearer {token}
Plain Text
복사
응답 (Response)
•
HTTP Status Codes:
◦
200 OK: 게시글 목록 조회 성공.
◦
400 Bad Request: 잘못된 요청.
•
응답 예시
HTTP/1.1 200 OK
{
"content": [
{
"id": 3,
"type": "FREE",
"title": "서브스트링 테스트",
"contentPreview": "게시글 내용이 긴 경우에는 어떻게 처...",
"thumbnail": "https://union-image-bucket.s3.ap-northeast-2.amazonaws.com/userToken/44009c26-13fc-4912-a3db-7cac644e39c5.png",
"createdAt": "2024-11-04T03:37:50.374905Z",
"author": {
"nickname": "user1nick",
"profileImage": "https://example.com/user1.png",
"univName": "University 1"
},
"views": 0,
"postLikes": 0,
"commentCount": 0
},
{
"id": 2,
"type": "FREE",
"title": "서브스트링 테스트",
"contentPreview": "게시글 내용이 긴 경우에는 어떻게 처...",
"thumbnail": "https://union-image-bucket.s3.ap-northeast-2.amazonaws.com/userToken/44009c26-13fc-4912-a3db-7cac644e39c5.png",
"createdAt": "2024-11-04T03:37:49.516079Z",
"author": {
"nickname": "user1nick",
"profileImage": "https://example.com/user1.png",
"univName": "University 1"
},
"views": 0,
"postLikes": 0,
"commentCount": 0
},
{
"id": 1,
"type": "FREE",
"title": "서브스트링 테스트",
"contentPreview": "게시글 내용이 긴 경우에는 어떻게 처...",
"thumbnail": "https://union-image-bucket.s3.ap-northeast-2.amazonaws.com/userToken/44009c26-13fc-4912-a3db-7cac644e39c5.png",
"createdAt": "2024-11-04T03:37:48.758335Z",
"author": {
"nickname": "user1nick",
"profileImage": "https://example.com/user1.png",
"univName": "University 1"
},
"views": 0,
"postLikes": 0,
"commentCount": 0
}
],
"pageable": {
"pageNumber": 0,
"pageSize": 3,
"sort": {
"empty": false,
"unsorted": false,
"sorted": true
},
"offset": 0,
"unpaged": false,
"paged": true
},
"last": true,
"totalPages": 1,
"totalElements": 3,
"first": true,
"size": 3,
"number": 0,
"sort": {
"empty": false,
"unsorted": false,
"sorted": true
},
"numberOfElements": 3,
"empty": false
}
JSON
복사