RESTful Web 服务 - Java (JAX-RS)
JAX-RS 代表 RESTful Web 服务的 JAVA API。JAX-RS 是一种基于 JAVA 的编程语言 API 和规范，用于为创建的 RESTful Web 服务提供支持。其 2.0 版本于 2013 年 5 月 24 日发布。JAX-RS 使用 Java SE 5 提供的注释来简化基于 JAVA 的 Web 服务创建和部署的开发。它还为创建 RESTful Web 服务的客户端提供支持。
规范
以下是将资源映射为 Web 服务资源的最常用注释。
| Sr.No. | 注释 &描述 |
|---|---|
1 |
@Path 资源类/方法的相对路径。 |
2 |
@GET HTTP Get 请求，用于获取资源。 |
3 |
@PUT HTTP PUT 请求，用于更新资源。 |
4 |
@POST HTTP POST 请求，用于创建新资源。 |
5 |
@DELETE HTTP DELETE 请求，用于删除资源。 |
6 |
@HEAD HTTP HEAD 请求，用于获取方法的状态可用性。 |
7 |
@Produces 声明 Web 服务生成的 HTTP 响应。例如，APPLICATION/XML、TEXT/HTML、APPLICATION/JSON 等。 |
8 |
@Consumes 声明 HTTP 请求类型。例如，application/x-www-formurlencoded 表示在 POST 请求期间接受 HTTP 主体中的表单数据。 |
9 |
@PathParam 将传递给方法的参数绑定到路径中的值。 |
10 |
@QueryParam 将传递给方法的参数绑定到路径中的查询参数。 |
11 |
@MatrixParam 将传递给方法的参数绑定到路径中的 HTTP 矩阵参数。 |
12 |
@HeaderParam 将传递给方法的参数绑定到 HTTP 标头。 |
13 |
@CookieParam 将传递给方法的参数绑定到Cookie。 |
14 |
@FormParam 将传递给方法的参数绑定到表单值。 |
15 |
@DefaultValue 为传递给方法的参数分配默认值。 |
16 |
@Context 上下文资源。例如，HTTPRequest 作为上下文。 |
注意 − 我们在 RESTful Web 服务 - 第一个应用程序 和 RESTful Web 服务 - 方法 章节中使用了 Jersey，这是 Oracle 的 JAX-RS 2.0 参考实现。
