페이징 처리 시 Response 의 형식

[kyukong]

현재는 페이징 처리해야 할 API 들이 없어서 고민하지 않고 넘어갔지만,
개발이 진행되다보면 페이징이 포함된 API 가 많아질 것이라 예상됩니다.

기본 Response 의 형식을 맞추었던 것처럼
Paging 시의 Response 형식도 맞추면 상호간에 파악하기 쉬울것이라 생각합니다.
제가 생각한 형식은 다음과 같습니다.

{
	success: boolean,
	error: {
		code: String,
		message: String
	},
	data: {
		"count": 2,
		"page": 1,
		"size": 10,
		"content": [
			...
		]
	}
}

• count : content 내용 개수
• page : 현재 페이지 (1부터 시작)
• size : 페이지에 띄울 데이터 개수
• content : 실제 내용

실제 API 에 대입해보면 응답하고 싶은 값은 content 에 포함합니다.

{
	success: boolean,
	error: {
		code: String,
		message: String
	},
	data: {
		"count": 2,
		"page": 1,
		"size": 10,
		"content": [
			{
				"applicationId": 1,
				"processId": 1,
				"companyName": "카카오커머스",
				"position": "디자인",
				"specificPosition": "UI 디자인",
				"processType": "TO_APPLY",
				"processDescription": "지원예정"
			},
			...
		]
	}
}

아래 내용에 대해 자유롭게 답글 부탁드립니다.

1. paging 처리 시 Response 응답 형식 고정 여부
2. 형식을 고정한다면
   2-1. 위의 4가지 항목으로 충분한지/필요없는 값도 있는지
   2-2. 네이밍은 적절한지
3. 형식을 고정하지 않는다면
   3-1. Response 시 어떻게 응답할지

[Byeongju-Kong]

일단, Paging 처리를 하니까, lastPage인지에 대한 boolean 응답이 있어야 할 것 같습니다!

그리고, 페이징 시의 포맷을 맞추는 것은 좋을 것 같은데, 필요할까? 라는 의문이 들어요!
count와 size의 차이는 무엇일까요..?

그리고 front에서 size=2&page=10 등의 형태로 요청을 보낼 것으로 예상되는데요. 응답 시에 이 값을을 다시 반환해줘야 하나..?라는 생각이 들어요!
응답을 주는 이유는 프론트에서 요청을 size=2&page=10의 쿼리스트링을 포함해서 보내고 응답 값이 프론트에서 요청한 대로 잘 내려지는지에 대해 다시 체크하기 위한 목적인 것 같은데요..! 과연 그 체크가 필요할까요? 백엔드에서 쿼리스트링에 해당하는 올바른 응답을 내려주는지에 대한 테스트로 충분할 것이라고 생각해요!

저는 결론 적으로 lastPage와 content 값만 있으면 될 것 같네요!