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

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

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

需要这份系统化的资料的朋友，可以戳这里获取

public class ApiController {

@GetMapping("/hello")
public String sayHello() {
    return "Hello, Spring Boot!";
}

@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 接口。


1. 创建 User 实体类：

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

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

private String username;
private String email;

// 省略getter和setter方法

}

2. 创建 UserController：

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

@Autowired
private UserRepository userRepository;

@GetMapping
public List<User> 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);
}

}

3. 创建 UserRepository：

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

#### 案例二：订单管理系统


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


1. 创建 Order 实体类：

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

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

private String orderNumber;
private String customerName;

// 省略getter和setter方法

}

2. 创建 OrderController：

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

@Autowired
private OrderRepository orderRepository;

@GetMapping
public List<Order> 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);
}

}

3. 创建 OrderRepository：

@Repository
public interface OrderRepository extends JpaRepository<Order, Long> {
}

#### 案例三：商品管理系统


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


1. 创建 Product 实体类：

@Entity
@Table(name = “products”)
public class Product {

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

private String name;
private String description;
private BigDecimal price;

// 省略getter和setter方法

}

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！

g-PXCuKZFX-1715788818948)]
[外链图片转存中…(img-ON4UXHLk-1715788818948)]

网上学习资料一大堆，但如果学到的知识不成体系，遇到问题时只是浅尝辄止，不再深入研究，那么很难做到真正的技术提升。

需要这份系统化的资料的朋友，可以戳这里获取

一个人可以走的很快，但一群人才能走的更远！不论你是正从事IT行业的老鸟或是对IT行业感兴趣的新人，都欢迎加入我们的的圈子（技术交流、学习资源、职场吐槽、大厂内推、面试辅导），让我们一起学习成长！