46.2. 기본 JAX-RS 주석
46.2.1. 개요
RESTful 웹 서비스 구현에 필요한 가장 기본적인 정보는 다음과 같습니다.
- 서비스 리소스의 URI
- 클래스의 메서드가 HTTP 동사에 매핑되는 방법
JAX-RS는 이러한 기본 정보를 제공하는 주석 세트를 정의합니다. 모든 리소스 클래스에는 이러한 주석 중 하나 이상이 있어야 합니다.
46.2.2. 경로 설정
@Path 주석은 리소스의 URI를 지정합니다. 주석은 javax.ws.rs.Path 인터페이스에서 정의되며 리소스 클래스 또는 리소스 메서드를 장식하는 데 사용할 수 있습니다. 문자열 값을 유일한 매개 변수로 사용합니다. string 값은 구현된 리소스의 위치를 지정하는 URI 템플릿입니다.
URI 템플릿은 리소스의 상대 위치를 지정합니다. 예 46.2. “URI 템플릿 구문” 에 표시된 대로 템플릿에는 다음이 포함될 수 있습니다.
- 처리되지 않은 경로 구성 요소
{}로 둘러싸인 매개 변수 식별자참고매개 변수 식별자는 기본 경로 처리를 변경하는 정규식을 포함할 수 있습니다.
예 46.2. URI 템플릿 구문
@Path("resourceName/{param1}/../{paramN}")
예를 들어 URI 템플릿 위젯 /{color}/{number} 는 위젯s /blue/12 에 매핑됩니다. color 매개변수 값은 파 란색에 할당됩니다. number 매개 변수의 값은 12 로 할당됩니다.
URI 템플릿이 전체 URI에 매핑되는 방법은 @Path 주석 장식에 따라 다릅니다. 루트 리소스 클래스에 배치되면 URI 템플릿은 트리의 모든 리소스의 루트 URI이며 서비스가 게시되는 URI에 직접 추가됩니다. 주석이 하위 리소스를 장식하는 경우 루트 리소스 URI를 기준으로 합니다.
46.2.3. HTTP 동사 지정
JAX-RS는 메서드에 사용할 HTTP 동사를 지정하기 위해 다섯 개의 주석을 사용합니다.
-
javax.ws.rs.DELETE는 메서드가
DELETE에 매핑되도록 지정합니다. -
javax.ws.rs.GET 메서드가
GET에 매핑되도록 지정합니다. -
javax.ws.rs.POST는 메서드가
POST에 매핑되도록 지정합니다. -
javax.ws.rs.PUT는 메서드가
PUT에 매핑되도록 지정합니다. -
javax.ws.rs.HEAD는 메서드가
HEAD에 매핑되도록 지정합니다.
메서드를 HTTP 동사에 매핑할 때 매핑이 의미가 있는지 확인해야 합니다. 예를 들어 구매 주문을 제출하려는 메서드를 매핑하는 경우 PUT 또는 POST 에 매핑합니다. GET 또는 DELETE 에 매핑하면 예기치 않은 동작이 발생합니다.
