API 명세서
| 헤더명 | 설명 |
|---|---|
| Authorization | 인증 시 발급받은 tokenBearer {token}
|
| Content-Type | Request body content type 지정 ex) application/json
|
| HttpStatusCode | Description |
|---|---|
| 400 | 잘못된 요청 |
| 500 | 서버 내부 오류 발생 |
| 필드명 | 설명 |
|---|---|
| statusCode | http 상태 코드 |
| requestUrl | 요청한 api의 url |
| resultCode | 요청한 api의 결과 |
| errorList | 오류 상세 정보 |
ex)
{
"statusCode": "400 BAD_REQUEST",
"requestUrl": "/api/news/views/1",
"resultCode": "FAIL",
"errorList": [
{
"field": "invalid Error",
"code": "N402",
"message": "존재하지 않는 newsId에 대해 요청했습니다.",
"invalidValue": "newsId: 1"
}
]
}
로그인
토큰 갱신
로그아웃
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 400 | A401 | 올바른 아이디 혹은 비밀번호가 아닙니다. | 아이디 혹은 비밀번호가 정규식을 만족하지 못했을 경우 |
| 400 | A402 | 올바른 토큰이 아닙니다. | 토큰을 확인하는 과정에서 오류가 있을 경우 |
| 400 | A403 | 허용 토큰 정보를 찾을 수 없습니다. | 해당 사용자에게 지정된 토큰이 없을 경우 |
| 400 | A404 | 허용된 접근 토큰이 아닙니다. | 해당 사용자에게 지정된 접근 토큰과 다를 경우 |
| 400 | A405 | 허용된 갱신 토큰이 아닙니다. | 해당 사용자에게 지정된 갱신 토큰과 다를 경우 |
| 400 | A406 | 접근 토큰이 만료되었습니다. | 유효 기간이 지난 접근 토큰이 전달된 경우 |
| 400 | A407 | 갱신 토큰이 만료되었습니다. | 유효 기간이 지난 갱신 토큰이 전달된 경우 |
| 400 | A408 | 갱신 토큰을 찾을 수 없습니다. | 갱신 토큰이 저장된 쿠키가 전달되지 않은 경우 |
| 400 | A409 | 토큰 정보에 해당하는 사용자를 찾을 수 없습니다. | 토큰으로 확인한 ID에 해당하는 사용자가 없을 경우 |
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |
사용자에 권한 부여
＋ Request body Schema
권한 추가
＋ Request body Schema
전체 회원 조회
회원 가입
＋ Request body Schema
ID 중복 확인
＋ Request body Schema
＋ Responses Schema
인증된 사용자 ID 조회
프로필 정보 조회
＋ Responses Schema
프로필 사진 URL 조회
프로필 변경
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 400 | U401 | 사용자의 프로필을 찾을 수 없습니다. | 기존 저장된 프로필을 찾을 수 없을 경우 |
| 400 | U402 | 파일이 이미지가 아닙니다. | 프로필 사진으로 첨부한 파일이 이미지 확장자가 아닐 경우 |
| 400 | U403 | 해당 권한을 찾을 수 없습니다. | 권한명에 해당하는 권한이 없을 경우 |
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |
전체 뉴스 조회
＋ Responses Schema
뉴스 상세 정보 조회
＋ Responses Schema
뉴스 접근 기록
＋ Request body Schema
조회수 업데이트
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 400 | N401 | 존재하지 않는 newsId에 대해 요청했습니다. | 뉴스 상세 정보 조회 시 요청한 newsId에 해당하는 뉴스가 없을 경우 |
| 400 | N402 | 존재하지 않는 newsId에 대해 요청했습니다. | 조회수 업데이트 시 요청한 newsId에 해당하는 뉴스가 없을 경우 |
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |
북마크 여부 확인
＋ Responses Schema
북마크 생성
＋ Request body Schema
북마크 삭제
＋ Request body Schema
특정 회원의 북마크 일괄 조회
＋ Responses Schema
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 400 | B401 | 해당 사용자는 북마크 하지 않았기 때문에 북마크 해제 요청을 할 수 없습니다. | 북마크 삭제 시 해당 기사에서 사용자의 북마크를 찾을 수 없을 경우 |
| 400 | B402 | 해당 사용자는 이미 해당 뉴스에 북마크 되어있기 때문에 북마크 요청을 할 수 없습니다. | 북마크 생성 시 해당 기사에서 사용자의 북마크가 이미 존재할 경우 |
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |
댓글 조회
＋ Responses Schema
프로필 페이지에서 유저가 작성한 댓글 조회
＋ Responses Schema
댓글 저장
＋ Request body Schema
댓글 수정
댓글 삭제
댓글 개수 조회
＋ Responses Schema
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 400 | C401 | 댓글 내용 또는 뉴스 아이디가 비어있습니다. | 요청받은 댓글 내용 혹은 뉴스 식별 id가 null일 경우 |
| 400 | C402 | 댓글을 불러올 수 없습니다. | 특정 뉴스 댓글 조회 시 해당 뉴스를 찾을 수 없을 경우 |
| 400 | C403 | 해당 댓글은 이미 삭제되었기 때문에 수정할 수 없습니다. | 댓글 수정 시 해당 댓글을 찾을 수 없을 경우 |
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |
전체 게시글 조회
＋ Responses Schema
게시글 생성
＋ Request body Schema
게시글 수정
＋ Request body Schema
＋ Responses Schema
게시글 식별 id
게시글 삭제
＋ Responses Schema
게시글 식별 id
사용자의 게시글 조회
＋ Responses Schema
| HttpStatusCode | code | message | Description |
|---|---|---|---|
| 500 | - | - | 서버 오류 혹은 예외 처리가 안된 경우 |