Java Spring Boot 写 API 接口_创建一个springboot项目写一个简单测试接口

最新推荐文章于 2025-04-08 10:00:00 发布

花开的季节293

最新推荐文章于 2025-04-08 10:00:00 发布

阅读量1.9k

点赞数 18

分类专栏： 2024年程序员学习文章标签： java spring boot 开发语言

本文链接：https://blog.csdn.net/2303_79055586/article/details/137763348

版权

2024年程序员学习专栏收录该内容

111 篇文章

订阅专栏

先自我介绍一下，小编浙江大学毕业，去过华为、字节跳动等大厂，目前阿里P7

深知大多数程序员，想要提升技能，往往是自己摸索成长，但自己不成体系的自学效果低效又漫长，而且极易碰到天花板技术停滞不前！

因此收集整理了一份《2024年最新软件测试全套学习资料》，初衷也很简单，就是希望能够帮助到想自学提升又不知道该从何学起的朋友。

既有适合小白学习的零基础资料，也有适合3年以上经验的小伙伴深入学习提升的进阶课程，涵盖了95%以上软件测试知识点，真正体系化！

由于文件比较多，这里只是将部分目录截图出来，全套包含大厂面经、学习笔记、源码讲义、实战项目、大纲路线、讲解视频，并且后续会持续更新

如果你需要这些资料，可以添加V获取：vip1024b （备注软件测试）

正文

}

@PostMapping(“/users”)
public User createUser(@RequestBody User user) {
// 保存用户到数据库
// …

return user;
}
}

在上面的示例中，我们定义了两个 API 接口：

GET /api/hello：当客户端发送 GET 请求时，Controller 将返回字符串 “Hello, Spring Boot!”。
POST /api/users：当客户端发送 POST 请求时，Controller 将接收一个 User 对象，并将其保存到数据库中。最后，Controller 将返回保存的 User 对象。

第三步：创建实体类

如果 API 需要处理和返回数据对象，可以创建一个实体类来表示数据模型。实体类通常与数据库表相对应，并且可以使用 ORM 工具（如 Hibernate）来映射到数据库。在实体类上使用 @Entity 注解，以表示该类是一个数据库实体。使用 @Id 和 @GeneratedValue 注解来定义实体的主键。

示例代码：

import javax.persistence.*;

@Entity
@Table(name = “users”)
public class User {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

private String name;

// 省略getter和setter方法
}

在上面的示例中，我们定义了一个名为 User 的实体类。它有一个 id 属性和一个 name 属性。id 属性用于标识 User 对象的唯一性，并使用 @GeneratedValue 注解指定自动生成主键。name 属性是一个字符串类型的属性，用于存储 User 的名称。

第四步：运行应用程序

现在，我们已经创建了一个简单的 Spring Boot 应用程序，其中包含一个 API 接口和一个实体类。我们可以启动应用程序，并访问 API 的 URL 路径来测试 API 接口。

启动应用程序：

$ mvn spring-boot:run

测试 API 接口：

$ curl http://localhost:8080/api/hello
Hello, Spring Boot!

$ curl -X POST -H “Content-Type: application/json”
-d ‘{“name”: “Alice”}’ http://localhost:8080/api/users
{“id”: 1, “name”: “Alice”}

在上面的示例中，我们使用 cURL 工具来测试 API 接口。通过 GET 请求 /api/hello 接口，我们得到了 “Hello, Spring Boot!” 的响应。通过 POST 请求 /api/users 接口，我们创建了一个名为 Alice 的 User 对象，并得到了新创建的 User 对象的响应。

案例

案例一：用户管理系统

假设我们要构建一个用户管理系统，可以实现用户的创建、查询、更新和删除操作。我们可以使用 Java Spring Boot 来构建这个系统的 API 接口。

创建 User 实体类：

@Entity
@Table(name = “users”)
public class User {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

private String username;
private String email;

// 省略getter和setter方法
}

创建 UserController：

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

@Autowired
private UserRepository userRepository;

@GetMapping
public List getUsers() {
return userRepository.findAll();
}

@GetMapping(“/{id}”)
public User getUserById(@PathVariable Long id) {
return userRepository.findById(id)
.orElseThrow(() -> new NotFoundException(“User not found”));
}

@PostMapping
public User createUser(@RequestBody User user) {
return userRepository.save(user);
}

@PutMapping(“/{id}”)
public User updateUser(@PathVariable Long id, @RequestBody User updatedUser) {
User user = userRepository.findById(id)
.orElseThrow(() -> new NotFoundException(“User not found”));

user.setUsername(updatedUser.getUsername());
user.setEmail(updatedUser.getEmail());

return userRepository.save(user);
}

@DeleteMapping(“/{id}”)
public void deleteUser(@PathVariable Long id) {
userRepository.deleteById(id);
}
}

创建 UserRepository：

@Repository
public interface UserRepository extends JpaRepository<User, Long> {
}

案例二：订单管理系统

假设我们要构建一个订单管理系统，可以实现订单的创建、查询、更新和删除操作。我们可以使用 Java Spring Boot 来构建这个系统的 API 接口。

创建 Order 实体类：

@Entity
@Table(name = “orders”)
public class Order {

@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;

private String orderNumber;
private String customerName;

// 省略getter和setter方法
}

创建 OrderController：

@RestController
@RequestMapping(“/api/orders”)
public class OrderController {

@Autowired
private OrderRepository orderRepository;

@GetMapping
public List getOrders() {
return orderRepository.findAll();
}

@GetMapping(“/{id}”)
public Order getOrderById(@PathVariable Long id) {
return orderRepository.findById(id)
.orElseThrow(() -> new NotFoundException(“Order not found”));
}

@PostMapping
public Order createOrder(@RequestBody Order order) {
return orderRepository.save(order);
}

@PutMapping(“/{id}”)
public Order updateOrder(@PathVariable Long id, @RequestBody Order updatedOrder) {
Order order = orderRepository.findById(id)
.orElseThrow(() -> new NotFoundException(“Order not found”));

order.setOrderNumber(updatedOrder.getOrderNumber());
order.setCustomerName(updatedOrder.getCustomerName());

return orderRepository.save(order);
}

@DeleteMapping(“/{id}”)
public void deleteOrder(@PathVariable Long id) {
orderRepository.deleteById(id);
}
}