v1 안좋은 방법

@GetMapping("/api/v1/members")
public List<Member> membersV1() {
	return memberService.findMembers();
}

• 너무 쉽게 만들었지만 문제가 많다.
  • 엔티티를 리턴 했다. 회원의 모든 정보가 보인다.
  • 그리고 api 별로 원하는 데이터가 다르다.
  • 엔티티 변경 시 api 스펙이 변경된다.
  • count도 넣어야 한다.

추천하는 형태

{
	"count": 4
	"data": []
}

• 스펙 확장이 가능
• 바로 array를 리턴 하면 스펙이 굳어져서 확장이 불가능

@GetMapping("api/v2/members")
public Result membersV2() {
	List<Member> findMembers = memberService.findMembers();
	List<MemberDTO> members = findMembers.stream()
			.map(m -> new MemberDTO(m.getName()))
			.collect(Collectors.toList());

	return new Result<>(members);
}

@Data
@AllArgsConstructor
private static class Result<T> {
	private T data;
}

@Data
@AllArgsConstructor
private static class MemberDTO {
	private String name;
}

• 이런 식으로

{
    "data": [
        {
            "name": "cmlee3"
        },
        {
            "name": "cmlee"
        },
        {
            "name": "user"
        }
    ]
}

만약 count가 필요하면

@GetMapping("api/v2/members")
public Result membersV2() {
	List<Member> findMembers = memberService.findMembers();
	List<MemberDTO> members = findMembers.stream()
			.map(m -> new MemberDTO(m.getName()))
			.collect(Collectors.toList());

	return new Result<>(/* count 쿼리 값 */, members);
}

@Data
@AllArgsConstructor
private static class Result<T> {
	private int count;
	private T data;
}