DELETE 메서드 구현 방법(feat. @DeleteMapping)

API를 작성하는 다양한 방법

HTTP 메서드에 해당하는 API를 개발하고 그 과정에서 필요한 내용들 중

하나인 DELETE 메서드의 구현에 관하여 자세하게 알아보겠습니다.

---

DELELE API

웹 애플리케이션 서버를 거쳐 데이터베이스 등의 저장소에 있는 리소스를 삭제할 때 사용한다.

서버에서 클라이언트로부터 리소스를 식별할 수 있는 값을 받아 데이터베이스나 캐시에 있는 리소스를 조회하고 삭제하는 역할을 한다.

컨트롤러를 통해 값을 받는 단계에서는 간단한 값을 받기 때문에, GET 메서드와 같이 URI에 값을 넣어 요청을 받는 형식으로 구현된다.

---

@PathVariable을 이용한 DELETE 메서드 구현

@PathVariable을 이용하면 URI에 포함된 값을 받아 로직을 처리할 수 있다.

@RestController
@RequestMapping("/api/v1/delete-api")
public class DeleteController {

    @DeleteMapping("/{variable}")
    public String deleteVariable(@PathVariable String variable) {
        return variable;
    }
}

@RequestParam을 이용한 DELETE 메서드 구현

@DeleteMapping 어노테이션에 정의된 value의 이름과 메서드의 매개변수 이름을 동일하게 설정해야 삭제할 값이 나온다.

@RequestParam 어노테이션을 통해 쿼리스트링의 값도 받을 수 있다.

@DeleteMapping(value = "/request1")
public String getRequestParam1(@RequestParam String email) {
    return "e-mail : " + email;
}