如何使用 Java 框架构建 RESTful API?

可以使用 java 框架 spring boot(步骤1-2)或 jax-rs(步骤3-4)来构建 restful api。在 spring boot 中,创建控制器类处理请求(步骤2),而在 jax-rs 中,创建 java 类并使用 @path 定义资源路径(步骤4)。此外,我们通过一个管理用户的 spring boot api 示例演示了实际应用(步骤5)。

如何使用 Java 框架构建 RESTful API?

RESTful API 是在互联网上与应用程序通信的常见方法。本文将引导你使用 Java 框架(如 Spring Boot 和 JAX-RS)构建 RESTful API。

1. Spring Boot 入门

Spring Boot 是一个流行的 Java 框架,用于快速创建 RESTful API。首先,创建一个新的 Spring Boot 项目,然后添加以下依赖项:


  org.springframework.boot
  spring-boot-starter-web

2. 定义 RESTful 控制器

创建控制器类以处理 API 请求。例如:

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

  // 获取所有用户
  @GetMapping
  public List getAllUsers() { ... }

  // 创建新用户
  @PostMapping
  public User createUser(@RequestBody User user) { ... }

  // 更新用户
  @PutMapping("/{id}")
  public User updateUser(@PathVariable Long id, @

RequestBody User user) { ... } // 删除用户 @DeleteMapping("/{id}") public void deleteUser(@PathVariable Long id) { ... } }

3. JAX-RS 入门

JAX-RS 是 Java EE 规范,用于构建 RESTful API。首先,添加以下依赖项:


  javax.ws.rs
  javax.ws.rs-api

4. 定义 RESTful 服务

创建 Java 类并使用 @Path 注解定义资源路径,例如:

@Path("/api/products")
public class ProductService {

  // 获取所有产品
  @GET
  @Produces("application/json")
  public List getAllProducts() { ... }
}

5. 实战案例:用户管理

我们创建一个管理用户的 Spring Boot API:

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

  @GetMapping
  public List getAllUsers(...) { ... }

  @PostMapping
  public User createUser(@RequestBody User user) { ... }

  @PutMapping("/{id}")
  public User updateUser(@PathVariable Long id, @RequestBody User user) { ... }

  @DeleteMapping("/{id}")
  public void deleteUser(@PathVariable Long id) { ... }
}

然后,我们可以测试 API:

curl -X POST http://localhost:8080/api/users -H 'Content-Type: application/json' -d '{"name": "John Doe", "email": "john.doe@example.com"}'