05. API를 작성하는 다양한 방법 - DELETE API 만들기

DELETE API 만들기

DELETE API는 웹 애플리케이션 서버를 거쳐 데이터베이스 등의 저장소에 있는 리소스를 삭제할 때 사용합니다.
서버에서는 클라이언트로부터 리소스를 식별할 수 있는 값을 받아 데이터베이스나 캐시에 있는 리소스를 조회하고 삭제하는 역할을 수행합니다.
이때 컨트롤러를 통해 값을 받는 단계에서는 간단한 값을 받기때문에 GET 메서드와 같이 URI 에 값을 넣어 요청을 받는 형식으로 구현합니다.

@PathVariable과 @RequestParam을 활용한 DELETE 메서드 구현

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

package com.springboot.api.controller;

import org.springframework.web.bind.annotation.*;

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

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

    @DeleteMapping("/request1")
    public String getRequestParam1(
            @RequestParam String email
    ) {
        return "email :" + email;
    }
}

@RequestParam 어노테이션은 쿼리 파라미터를 받는데 사용되며, 이는 주로 GET 요청에서 사용합니다. 
DELETE 요청에서는 보통 URL 경로의 일부로 데이터를 전달하므로 @PathVariable 어노테이션을 사용해야 합니다.