Springboot

PUT API 생성

수아파파's 2023. 9. 17. 19:53
반응형

스프링 부트에서 PUT API를 생성하려면 다음과 같은 단계를 따를 수 있습니다.

1. 컨트롤러 클래스 생성: PUT API를 처리할 컨트롤러 클래스를 생성합니다.

예를 들어, UserController라는 클래스를 생성합니다. 

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

    @PutMapping("/{id}")
    public ResponseEntity<?> updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
        // TODO: id에 해당하는 사용자 정보를 업데이트하는 로직 작성
        return ResponseEntity.ok().build();
    }
}

2. 요청 경로와 HTTP 메서드 매핑: `@RequestMapping` 애노테이션을 사용하여 요청 경로를 매핑합니다. 위의 예제에서는 "/users/{id}" 경로에 PUT 메서드를 매핑하였습니다.

 

3. 요청 파라미터 받기: `@PathVariable` 애노테이션을 사용하여 URL 경로에 있는 변수를 받습니다. 위의 예제에서는 `id` 변수를 받아와서 사용하고 있습니다. `@RequestParam` 애노테이션을 사용하여 URL 쿼리 파라미터를 받아올 수도 있습니다.

 

4. 요청 본문 받기: `@RequestBody` 애노테이션을 사용하여 요청 본문을 받아옵니다. 위의 예제에서는 `updatedUser` 객체로 요청 본문을 받아오고 있습니다. 본문은 JSON 형식으로 전달되므로, `User` 클래스는 JSON 데이터를 매핑하기 위한 모델 클래스여야 합니다.

 

5. 응답 반환: `ResponseEntity` 객체를 사용하여 응답을 반환합니다. 위의 예제에서는 성공적인 응답을 위해 `ResponseEntity.ok().build()`를 사용하였습니다. 필요한 경우, 응답에 데이터를 추가해주어도 됩니다. 이제 PUT API가 생성되었으며, 해당 API를 호출하면 PUT 요청이 처리됩니다.

반응형

'Springboot' 카테고리의 다른 글

@ResponseEntity를 활용한 PUT 메서드 예제  (0) 2023.09.17
DELETE API 생성  (0) 2023.09.17
POST API 생성  (0) 2023.09.17
DTO 객체를 활용한 GetMapping 사용법  (0) 2023.09.17
@RequestParam 활용한 GetMapping 사용법  (0) 2023.09.17