Swagger @ApiOperation , @ApiParam, @NoArgsConstructor(access = AccessLevel.PROTECTED) , @AllArgsConstructor(access = AccessLevel.PRIVATE)

Swagger는 아직 공부 해야함. 그전에

 

@ApiOperation을 사용하여 해당 API에 대한 설명을 추가할 수 있다.
@ApiParam을 사용하여 매개 변수에 대한 세부 정보를 추가하거나 고드에서 읽을 때 값을 변경할 수 있다.

 

 

 

 

@NoArgsConstructor(access = AccessLevel.PROTECTED) , 

기본 생성자의 접근 제어를 PROTECTED로 설정해놓게 되면 무분별한 객체 생성에 대해 한번 더 체크할 수 있는 수단이 되기 때문입니다.

 

예를 들어 User라는 Class는 name, age, email 정보를 모두 가지고있어야만 되는 상황일경우에

기본 생성자를 막는것은 이를 도와주는 좋은 수단이 됩니다.

 

User의 멤버변수들을 설정할 방법이 없으니 Setter를 만들어서 값을 설정하지만
실수로 setAge()를 누락할 경우 객체는 불완전한 상태가 되버립니다.

 

하지만 아래와 같이 변경하게 되면 IDE 단계에서 누락을 방지할 수 있게 되어 훨씬 수월하게 작업할 수 있게 되고 이는 엄청난 가치입니다.

 

 

@AllArgsConstructor(access = AccessLevel.PRIVATE)

말 그대로 '모든 매개변수 생성자'인 것 처럼 해당 클래스 내의 모든 변수값을 가진 생성자를 자동으로 만들어 준다.

접근 Level	접근 할 수 없는 클래스
protected	다른 패키지에 소속된 클래스 (상속 제외)
private	모든 외부 클래스

 

 

 

https://velog.io/@changyeonyoo/Swagger-%ED%94%84%EB%A1%9C%EC%A0%9D%ED%8A%B8-%EC%A0%81%EC%9A%A9%EA%B3%BC-%EC%96%B4%EB%85%B8%ED%85%8C%EC%9D%B4%EC%85%98

Swagger 프로젝트 적용과 어노테이션

 

https://cobbybb.tistory.com/14

@NoargsConstructor(AccessLevel.PROTECTED) 와 @Builder

 

 

https://erjuer.tistory.com/106

[JPA] Entity Class의 @NoargsConstructor (access = AccessLevel.PROTECTED)