spring boot Restful API代码示例
时间: 2023-05-31 11:06:45 浏览: 116
Spring boot restful api demo
4星 · 用户满意度95%
下面是一个简单的 Spring Boot Restful API 代码示例:
```java
@RestController
@RequestMapping("/api")
public class ApiController {
@Autowired
private UserService userService;
@GetMapping("/users")
public List<User> getAllUsers() {
return userService.getAllUsers();
}
@GetMapping("/users/{id}")
public User getUserById(@PathVariable Long id) {
return userService.getUserById(id);
}
@PostMapping("/users")
public User createUser(@RequestBody User user) {
return userService.createUser(user);
}
@PutMapping("/users/{id}")
public User updateUser(@PathVariable Long id, @RequestBody User user) {
return userService.updateUser(id, user);
}
@DeleteMapping("/users/{id}")
public void deleteUser(@PathVariable Long id) {
userService.deleteUser(id);
}
}
```
这个示例中,我们定义了一个 RestController,处理与用户相关的 API 请求。我们注入了一个 UserService,它负责处理业务逻辑。
我们定义了以下 API:
1. 获取所有用户:GET /api/users
2. 根据 ID 获取用户:GET /api/users/{id}
3. 创建用户:POST /api/users
4. 更新用户:PUT /api/users/{id}
5. 删除用户:DELETE /api/users/{id}
我们使用 @GetMapping、@PostMapping、@PutMapping 和 @DeleteMapping 注解来定义方法的 HTTP 请求类型。我们还使用 @PathVariable 和 @RequestBody 注解来获取请求的参数。
我们返回 User 对象作为响应,Spring Boot 会自动将其序列化为 JSON 格式。
如果我们想要访问这个 API,我们可以使用 HTTP 客户端发送请求,例如:
```http
GET /api/users HTTP/1.1
Host: localhost:8080
```
响应:
```json
[
{
"id": 1,
"name": "Alice",
"email": "alice@example.com"
},
{
"id": 2,
"name": "Bob",
"email": "bob@example.com"
}
]
```
这个示例中,我们获取了所有用户的列表。我们可以使用类似的方式访问其他 API。
阅读全文