API REST API를 위한 @PathVariable 사용법

@PathVariable 이란?

REST API에서 URI에 변수가 들어가는걸 실무에서 많이 볼 수 있다.

예를 들면, 아래 URI에서 밑줄 친 부분이 @PathVariable로 처리해줄 수 있는 부분이다.

http://localhost:8080/api/user/1234

https://music.bugs.co.kr/album/4062464

 

사용법

Controller에서 아래와 같이 작성하면 간단하게 사용 가능하다.

1. @GetMapping(PostMapping, PutMapping 등 다 상관없음)에 {변수명}
2. 메소드 정의에서 위에 쓴 변수명을 그대로 @PathVariable("변수명") 
3. (Optional) Parameter명은 아무거나 상관없음(아래에서 String name도 OK, String employName도 OK)

@RestController
public class MemberController { 
    // 기본
    @GetMapping("/member/{name}")
    public String findByName(@PathVariable("name") String name ) {
        return "Name: " + name;
    }
    
    // 여러 개
    @GetMapping("/member/{id}/{name}")
	public String findByNameAndId(@PathVariable("id") String id, @PathVariable("name") String name) {
    	return "ID: " + id + ", name: " + name;
    }
    
}

 

출처: https://byul91oh.tistory.com/435 [개꼬 [: 개발하는 꼬바리]:티스토리]

 

 

나의 Example

    @PostMapping({"/api/v1/board/{boardId}/reply"})
    public void save(@PathVariable Long boardId, @RequestBody Reply reply, @AuthenticationPrincipal PrincipalDetail principalDetail) {
        this.replyService.replySave(boardId, reply, principalDetail.getUser());
    }

    @DeleteMapping({"/api/v1/board/{boardId}/reply/{replyId}"})
    public void delete(@PathVariable Long replyId) {
        this.replyService.replyDelete(replyId);
    }

    public ReplyApiController(final ReplyService replyService) {
        this.replyService = replyService;
    }
}

위 {boardId} 부분을 

@PathVariable Long boardId <--로 처리해서 받음.

 

아래에 마찬기지로 {boardId} 가 있고, {replyId}가 있음

@PathVariable Long replyId <-  {replyId} 부분을 replyId로 받음. 위에서 {boardId} 부분은 이미 정해줬기 때문에 각 부분에 값들이 대입되어서 사용됨.