Spring Boot 是一个开源的、基于 Spring 的框架,用于快速创建独立的、生产级别的基于 Spring 的应用。REST API 是一种流行的网络服务架构风格,用于构建可扩展的、高性能的网络应用。
在这个教程中,我们将学习如何使用 Spring Boot 创建一个简单的 REST API。
安装和设置
首先,你需要安装 Java 和 Maven。然后,你可以使用 Spring Initializr 来创建一个新的 Spring Boot 项目。
创建 REST 控制器
在 Spring Boot 应用中,控制器是处理 HTTP 请求的核心组件。下面是一个简单的 REST 控制器示例:
@RestController
@RequestMapping("/api/products")
public class ProductController {
@GetMapping
public List<Product> getAllProducts() {
// 查询所有产品
return productRepository.findAll();
}
@GetMapping("/{id}")
public Product getProductById(@PathVariable Long id) {
// 根据 ID 查询产品
return productRepository.findById(id).orElseThrow(() -> new RuntimeException("Product not found"));
}
@PostMapping
public Product createProduct(@RequestBody Product product) {
// 创建新产品
return productRepository.save(product);
}
@PutMapping("/{id}")
public Product updateProduct(@PathVariable Long id, @RequestBody Product product) {
// 更新产品
return productRepository.findById(id).map(existingProduct -> {
existingProduct.setName(product.getName());
existingProduct.setPrice(product.getPrice());
return productRepository.save(existingProduct);
}).orElseThrow(() -> new RuntimeException("Product not found"));
}
@DeleteMapping("/{id}")
public void deleteProduct(@PathVariable Long id) {
// 删除产品
productRepository.deleteById(id);
}
}
使用 REST 客户端
你可以使用各种工具来测试 REST API,例如 Postman 或 curl。
以下是一个使用 curl 测试 GET 请求的示例:
curl http://localhost:8080/api/products
总结
在这个教程中,我们学习了如何使用 Spring Boot 创建一个简单的 REST API。你可以通过添加更多的功能来扩展你的 API,例如用户认证、数据验证等。