Spring @PathVariable 어노테이션 쉽게 정리

Spring @PathVariable 어노테이션 쉽게 정리

REST API호출 경험이 있다면, URI값에 가변형 변수를 전달해서 처리하는 방식을 본적이 있을것이다.

 

http://127.0.0.1/users?userId={$userId}

http://127.0.0.1/users/{userId}

 

위에는 일반적인 GET 방식의 파라미터 전달이라 흔히 볼수있었다.

아래는 케이스는 Rest Api호출시 주로 많이 사용하게 된다.

URI를 이용해 파라미터 처리를 할수있다는 뜻이다.

 

 

@PathVariable 사용 방법

pathVariable 사용예제는 아래에서 자세히 알아보시기 바랍니다.

 

import lombok.AllArgsConstructor;
import lombok.Data;

@Data
@AllArgsConstructor
public class User {
    String userId;
}

    @GetMapping(path="/users/{userId}")
    public User userBean(@PathVariable String userId){
        return new User(userId);
    }

1. @GetMapping path의 {변수} 괄호안에 괄호 그레이스를 열어 URI에 사용될 변수 명을 입력한다.

    GetMapping 뿐만 아니라 당연히 다른 Method도 가능하다.  ( PostMapping, DeleteMapping, PutMapping......)

2. @PathVariable 어노테이션을 이용해서 {템플릿 변수} 와 동일한 이름을 갖는 파라미터를 추가하면 된다.

 

호출 테스트

호출 테스트 결과는 아래에서 자세히 확인해보시기 바랍니다.

 

아래 스프링 공식 홈페이지에서 제공하는 튜토리얼 링크를 남기니, 내용을 확인하시고 더 자세히 알아보시기 바랍니다

스프링 공식홈페이지 튜토리얼 (클릭)

 

 

 

 

@Size 어노테이션이 작동을 안할때

 

RestTemplate GET POST 호출 예제

 

[Spring boot] 간단 정리 REST API 버전 관리 방법(URI, Parameter, Header, mimetype )