[Spring] Annotation 정리

백앤드 Spring 코드를 봐야할 일이 생기어 접하게 되었고,

그 안에 수 많은 어노테이션이 무엇을 의미 하는지 정리가 필요하다.

 

@RequiredArgsConstructor
: (롬복) 필수 필드 생성자를 자동으로 생성

@RestController
: 들어오는 HTTP요청을 처리하는 역할

@Tag
: (OpenAPI/Swagger) API문서에 태그를 지정하는 역할
: 백엔드로 간단하게 뷰를 보여주는 것

@GetMapping
: HTTP GET요청을 매핑함

@Operation
: (OpenAPI/Swagger) API문서 또는 메서드 설명용도로 사용 됨

@ApiResponse
: (OpenAPI/Swagger) API작업 가능한 응답을 설명하는 용도

@Parameter
: (OpenAPI/Swagger) API작업에서 매개변수 설명 용도

@RequestParam
: 메서드의 매개변수를 웹 요청 매개변수에 바인딩함

@Valid
: 메서드 매개변수를 검증해야 함, 주로 Spring의 검증 프레임워크와 함께 사용됨

@PostMapping
: HTTP POST 요청 매핑

@PutMapping
: HTTP PUT 요청 매핑

@Repository
: 클래스가 Spring Data Repository임 명시, DB 상호 작용 캡슐화

@ToString
: (Lombok롬복) 'toString()'을 자동으로 생성

@Setter
: (Lombok 롬복) 클래스의 모든 필드의 Setter 생성

@Getter
: (Lombok 롬복) 클래스내 모든 필드의 Getter 생성

@Schema
: (Swagger) 이름, 설명, 필드를 명시
: name, description, example

 

---

2023-01-05-금 이곳에 AOS Annotation도 추가해보자..

RequiresApi : 지정한 API 보다 낮은 상태에서 함수 호출시에러 발생

TargetApi : 지정한 API 이상에서 사용해야 함을 알림