1. API 요청 바디 형식 : application/json (따로 명시되어 있지 않을 때)
2. API 요청 헤더 형식 : "Authorization : Bearer [token]"을 추가 (따로 명시되어 있지 않을 때)

API 응답 형식 (정상 처리)

{
	"data" : {
		Object (요청에 대한 반환 데이터)
	},
	"pageInfo" : {
		"currentPage" : int,
		"totalPages" : int,
		"numberOfElements" : int,
		"pageSize" : int,
		"totalElements" : int
	},
	"message" : String (반환 메시지)
}

API 응답 형식 (에러 발생)

{
	"message" : String (반환 메시지),
	"timestamp" : LocalDateTime (에러 발생 시각),
	"status" : Integer (상태 코드),
	"error" : String (에러 메시지),
}
{
	"message" : String (반환 메시지),
	"timestamp" : LocalDateTime (에러 발생 시각),
	"status" : Integer (상태 코드),
	"error" : String (에러 메시지),
	"errors" : {
			"name" : "이름은 공백일 수 없습니다",
			"age" : "나이는 0이상이어야 합니다"
		}
	}
}

<aside> 🤔 프론트분들과 상의해야 할 부분

  1. 영상에 대한 댓글을 영상 정보 반환할 때 같이 반환하기 or 영상 정보 따로, 영상에 대한 댓글 따로 api 만들기

    ⇒ 댓글 없음

  2. 영상 수정의 범위는 어떻게 정해졌나요?

</aside>

api 문서 json 형식은 Name 클릭하시면 됩니다!

API 문서 / check list

⇒ 어플 사용 전 무조건 로그인을 해야 한다면 모든 기능에서 API 요청 헤더에 Authorization 포함!

알림기능


For 백엔드 분들) 공통 응답/예외 사용 방법