1. API 개발 기본

1. 회원 등록 API

@PostMapping("/api/v2/members")
public CreateMemberResponse saveMemberV2(@RequestBody @Valid CreateMemberRequest request) {
    Member member =new Member();
    member.setName(request.getName());

    Long id = memberService.join(member);
    return new CreateMemberResponse(id);
}

- 엔티티와 프레젠테이션 로직을 분리

- 엔티티는 엔티티 용도로만 프레젠테이션은 validate 등등

- 엔티티와 api 스펙을 분리 - 엔티티가 변해도 api 스펙은 변하지 않는다는 장점

- 실무에서는 엔티티를 외부에 노출해서는 안된다. + 엔티티를 그대로 파라미터로 받는 것은 안하는게 좋다.

- api는 요청 들어오는 것과 응답 나가는 것은 절대 엔티티를 사용하지 않는다. - DTO 객체를 사용한다.

 

2. 회원 수정 API

- 커맨드와 쿼리를 철저하게 분리한다.

@PutMapping("/api/v2/members/{id}")
public UpdateMemberResponse updateMemberV2(
        @PathVariable("id") Long id,
        @RequestBody @Valid UpdateMemberRequest request) {

    memberService.update(id, request.getName());
    Member findMember = memberService.findOne(id);
    return new UpdateMemberResponse(findMember.getId(), findMember.getName());
}

 

3. 회원 조회 API

응답 값으로 엔티티를 직접 외부에 노출한 경우

- 문제점

    ㆍ엔티티에 프레젠테이션 계층을 위한 로직이 추가된다

    ㆍ기본적으로 엔티티의 모든 값이 노출된다.

    ㆍ응답 스펙을 맞추기 위해 로직이 추가된다. (@JsonIgnore, 별도의 뷰 로직 등등)

    ㆍ실무에서는 같은 엔티티에 대해 API가 용도에 따라 다양하게 만들어지는데,

        한 엔티티에 각각의 API를 위한 프레젠테이션 응답 로직을 담기는 어렵다

    ㆍ엔티티가 변경되면 API 스펙이 변한다.

    ㆍ추가로 컬렉션을 직접 반환하면 향후 API 스펙을 변경하기 어렵다.(별도의 Result 클래스 생성으로 해결)

- 결론

    ㆍAPI 응답 스펙에 맞추어 별도의 DTO를 반환한다.

 

* 참고 : 엔티티를 외부에 노출하지 마라

@GetMapping("/api/v2/members")
public Result memberV2() {
    List<Member> findMembers = memberService.findMembers();
    List<MemberDto> collect = findMembers.stream()
            .map(m -> new MemberDto(m.getName()))
            .collect(Collectors.toList());
    return new Result(collect.size(),collect);
}

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