理解GET和POST请求以及如何有效运用查询参数（req.query）和路由参数（req.params）是构建健壮API的关键。
GET请求
GET请求用于从服务器获取数据，类似于提出问题，不会修改服务器状态。
// 客户端请求:
fetch('https://api.example.com/users?id=123');
// 服务器端:
app.get('/users', (req, res) => {
const { id } = req.query; // 获取查询参数
res.send(`用户数据，ID: ${id}`);
});
GET请求特点：
- 数据通过URL查询参数传递。
- 幂等性：多次相同的请求不会改变服务器状态。
- 非常适合数据检索操作。
POST请求
当需要向服务器发送数据以创建或更新资源时，使用POST请求。
// 客户端请求:
fetch('https://api.example.com/users', {
method: 'POST',
headers: { 'Content-Type': 'application/json' },
body: JSON.stringify({ name: 'John', age: 30 }),
});
// 服务器端:
app.post('/users', (req, res) => {
const { name, age } = req.body; // 获取POST请求体数据
res.send(`创建用户 ${name}，年龄: ${age}`);
});
路由参数 (req.params)
路由参数是URL路径的一部分，用于标识特定资源，在路由定义中用冒号(:)表示。
// 路由定义:
app.get('/user/:id', (req, res) => {
const { id } = req.params; // 从路由中提取ID
res.send(`用户ID: ${id}`);
});
// 客户端请求:
fetch('https://api.example.com/user/123');
在这个例子中，123 成为 id 参数，用于标识所需资源。
查询参数 (req.query)
查询参数位于URL的?之后，用于传递可选数据或过滤器。
// 路由定义:
app.get('/users', (req, res) => {
const { rateLimit, page } = req.query; // 获取查询参数
res.send(`速率限制: ${rateLimit}, 页码: ${page}`);
});
// 客户端请求:
fetch('https://api.example.com/users?rateLimit=50&page=2');
组合使用路由参数和查询参数
可以同时使用路由参数和查询参数来创建更精确的请求：
// 路由定义:
app.get('/user/:id', (req, res) => {
const { id } = req.params; // 路由参数
const { details } = req.query; // 查询参数
res.send(`用户ID: ${id}, 详情: ${details}`);
});
// 客户端请求:
fetch('https://api.example.com/user/123?details=full');
快速参考表
| 特性 | 路由参数 (req.params) | 查询参数 (req.query) |
|---|---|---|
| 目的 | 标识特定资源 | 提供附加信息 |
| 位置 | 定义在URL路径中 | 附加在URL的?之后 |
| 是否必需 | 是 | 否 |
| 示例 | /user/:id |
/users?rateLimit=50 |
最佳实践
- 使用路由参数 (req.params) 用于：强制性资源标识符 (例如用户ID，产品ID)，基本路径组件。
- 使用查询参数 (req.query) 用于：可选过滤器，分页，排序选项，附加选项。
- 始终记录您的API端点，包含示例请求，列出所有可能的参数，并解释参数约束。
总结
理解何时使用路由参数和查询参数对于创建直观且易于维护的API至关重要。路由参数擅长标识资源，而查询参数提供了数据检索的灵活性。两者结合，构成了强大的API设计工具集，有助于构建有效的RESTful API。
