API请求参数的传递：从单参数到复杂对象

2023-12-26 05:37:32

在 API 中优雅地传递请求参数：前端和后端的紧密合作

在构建 API 时，前端和后端团队需要携手合作，以确保数据在两者之间无缝传递。其中，请求参数的处理是至关重要的。本文将深入探讨如何处理不同类型的请求参数，并通过代码示例引导你轻松实现 API 参数的传递。

单参数传递：简洁明了

当需要传递一个简单的字符串参数时，前端可以使用 axios.put() 或 axios.post() 方法，并在请求体中指定参数的值。后端则使用 @RequestParam 注解来接收参数，它可以指定参数名称、类型和默认值。

// 前端代码
axios.put('/api/v1/users/1', { name: 'John Doe' });

// 后端代码
@PutMapping("/api/v1/users/{id}")
public void updateUser(@PathVariable Long id, @RequestParam String name) {
    // 业务逻辑
}

复杂对象传递：深入探究

当需要传递一个复杂对象时，前端通过 axios.post() 方法发送请求，并在请求体中指定对象的 JSON 字符串。后端使用 @RequestBody 注解来接收对象，它能自动将 JSON 字符串转换为 Java 对象。

// 前端代码
const user = { name: 'John Doe', age: 30 };
axios.post('/api/v1/users', user);

// 后端代码
@PostMapping("/api/v1/users")
public void createUser(@RequestBody User user) {
    // 业务逻辑
}

单字段传递：聚焦于特定属性

有时候，只传递一个对象的特定字段就足够了。前端使用 axios.put() 或 axios.post() 方法，并在请求体中指定字段名称和值。后端依然使用 @RequestParam 注解接收字段，并可指定其名称、类型和默认值。

// 前端代码
axios.put('/api/v1/users/1', { name: 'John Doe' });

// 后端代码
@PutMapping("/api/v1/users/{id}")
public void updateUserName(@PathVariable Long id, @RequestParam String name) {
    // 业务逻辑
}