Spring Boot是Spring框架的一个子项目，它简化了Spring应用的初始搭建以及开发过程。REST API（Representational State Transfer API）是一种用于构建网络服务的架构风格。本教程将介绍如何在Spring Boot中创建REST API。

简介

Spring Boot REST API允许你轻松地创建基于HTTP的API。这些API可以用来提供数据、执行操作或与外部系统交互。

快速开始

以下是一个简单的Spring Boot REST API示例：

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

    @GetMapping("/users")
    public List<User> getAllUsers() {
        // 返回所有用户
        return Arrays.asList(new User(1, "Alice"), new User(2, "Bob"));
    }
}

在这个例子中，我们创建了一个UserController类，其中包含一个getAllUsers方法。这个方法使用@GetMapping注解来映射HTTP GET请求到/api/users路径。

路径参数

路径参数允许你从URL中获取信息。以下是如何使用路径参数：

@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
    // 根据ID获取用户
    return new User(id, "Alice");
}

在这个例子中，{id}是一个路径参数，它表示用户ID。

请求体参数

请求体参数允许你在请求体中发送数据。以下是如何使用请求体参数：

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    // 创建用户
    return user;
}

在这个例子中，@RequestBody注解将请求体中的JSON数据映射到User对象。

响应

Spring Boot REST API允许你返回不同类型的响应。以下是如何返回不同类型的响应：

@GetMapping("/users")
public ResponseEntity<List<User>> getAllUsers() {
    // 返回所有用户
    return ResponseEntity.ok(Arrays.asList(new User(1, "Alice"), new User(2, "Bob")));
}

在这个例子中，我们使用ResponseEntity来返回一个包含用户列表的响应。

扩展阅读

想要了解更多关于Spring Boot REST API的信息，请查看以下链接：

图片

Spring Boot REST API的架构图：

Spring Boot REST API Architecture