API 분리와 파라미터

API 분리

공통으로 예외처리를 할때 패키지나 구성단위로 많이 한다.

API와 화면은 공통 처리해야할 요소가 다르다.

⇒ 패키지를 분리하자

패키지 분리

Post방식 API 작성

1번 방식

@PostMapping("/api/v1/members")
    public CreateMemberResponse saveMemberV1(@RequestBody @Valid Member member){
        Long id = memberService.join(member);
        return new CreateMemberResponse(id);
    }

API 스펙을 위한 별도의 DTO를 만들어야 한다.

별도의 클래스를 안 만들어도 되니 편할 것 같지만

외부에서 오는 json을 바인딩 받아쓰면 나중에 큰 장애가 발생할 수 있다.

 

💡 API를 만들 때는 Entity를 파라미터로 받지 말자!
또한 Entity를 외부에 노출하지 않는 것이 좋다.

 

2번 방식

@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);
    }

2번 방식을 써야 하는 이유

중간에 파라미터와 entity를 한 번 매핑해주기 때문에

entity 내용이 바뀌면 값이 변경된 것을 확인할 수 있다.

또한 별도의 innerclass로 관리하기 때문에 유지 보수에 매우 용이하다.

 

💡 파라미터로 Entity를 넘기면 API 문서를 확인하지 않고서는 해당 Entity의 어느 부분이 파라미터로 넘어가는지 알 수 없다. ⇒ Side Effect가 나타날 수 있다.