REST를 위한 주요 어노테이션은 뭐가있을까요

[dnjs0]

🤨

[dnjs0]

✅ 1. Controller 정의 및 설정

• RestController: JSON 응답을 반환하는 REST API용 컨트롤러
• Controller: 뷰 반환용 (HTML)
• ResponseBody: 메서드의 반환값을 HTTP 응답 본문에 직접 출력

@RestController
@RequestMapping("/api")
public class UserController {

    @GetMapping("/hello")
    public String hello() {
        return "Hello, REST";
    }
}

---

✅ 2. HTTP 요청 메서드 매핑

• GetMapping: 조회
• PostMapping: 등록
• PutMapping: 전체 수정
• DeleteMapping: 삭제
• PatchMapping: 부분 수정

@RestController
@RequestMapping("/api/users")
public class UserController {

    @GetMapping("/{id}")
    public User getUser(@PathVariable Long id) {
        return userService.findById(id);
    }

    @PostMapping
    public User createUser(@RequestBody User user) {
        return userService.save(user);
    }

    @PutMapping("/{id}")
    public User updateUser(@PathVariable Long id, @RequestBody User user) {
        return userService.update(id, user);
    }

    @DeleteMapping("/{id}")
    public void deleteUser(@PathVariable Long id) {
        userService.delete(id);
    }
}

---

✅ 3. 요청 데이터 바인딩

• PathVariable: 경로의 값을 변수로 추출
• RequestParam: 쿼리 파라미터 추출
• RequestBody: 요청 본문(JSON)을 객체로 매핑
• ModelAttribute: 폼 데이터 바인딩
• RequestHeader: 요청 헤더값 추출
• CookieValue: 쿠키에서 값 추출

@GetMapping("/users/{id}")
public User getUser(@PathVariable Long id) {
    return userService.findById(id);
}

@GetMapping("/search")
public List<User> searchUsers(@RequestParam String name) {
    return userService.findByName(name);
}

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    return userService.save(user);
}

@PostMapping("/form")
public String submitForm(@ModelAttribute UserForm form) {
    return "ok";
}

---

✅ 4. 응답 및 예외 처리

• ResponseStatus: 응답 상태 코드 설정
• ExceptionHandler: 특정 예외 발생 시 처리 메서드 지정
• RestControllerAdvice: 전역 예외 처리 클래스
• CrossOrigin: CORS 허용

@DeleteMapping("/users/{id}")
@ResponseStatus(HttpStatus.NO_CONTENT)
public void delete(@PathVariable Long id) {
    userService.delete(id);
}

@CrossOrigin(origins = "http://localhost:3000")
@RestController
public class ApiController {

    @GetMapping("/public")
    public String publicApi() {
        return "CORS 허용됨";
    }
}

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserNotFoundException.class)
    public ResponseEntity<String> handleNotFound(UserNotFoundException ex) {
        return ResponseEntity.status(HttpStatus.NOT_FOUND).body(ex.getMessage());
    }
}

---