RESTful API 是一种常用的 Web API 设计风格，它使用 HTTP 协议中的 GET、POST、PUT、DELETE 等请求方法来实现对资源的操作。在使用 RESTful API 时，请求参数的处理至关重要。本文将介绍 RESTful API 请求参数的处理方法，包括参数类型、参数传递方式、参数校验等方面，并提供示例代码。
参数类型
RESTful API 请求参数主要有两种类型：查询参数和请求体参数。
查询参数
查询参数是通过 URL 中的查询字符串传递的参数，例如：
http://example.com/api/users?name=john&age=30
查询参数通常用于 GET 请求，用于过滤、排序、分页等操作。查询参数的优点是易于调试和缓存，但是传递的数据量有限，不适合传递大量数据。
请求体参数
请求体参数是通过 HTTP 请求体传递的参数，例如：
POST /api/users HTTP/1.1
Content-Type: application/json
{
"name": "john",
"age": 30
}请求体参数通常用于 POST、PUT、PATCH 等请求，用于传递大量数据或复杂数据结构。请求体参数的优点是可以传递任意类型的数据，但是需要注意请求体大小的限制。
参数传递方式
RESTful API 请求参数的传递方式主要有三种：URL 编码、JSON 编码和表单编码。
URL 编码
URL 编码是将参数以查询字符串的形式附加在 URL 后面，例如：
http://example.com/api/users?name=john&age=30
URL 编码适合传递简单的参数，但是不适合传递复杂的数据结构。
JSON 编码
JSON 编码是将参数以 JSON 格式编码在请求体中传递，例如：
POST /api/users HTTP/1.1
Content-Type: application/json
{
"name": "john",
"age": 30
}JSON 编码适合传递复杂的数据结构，但是需要注意请求体大小的限制。
表单编码
表单编码是将参数以表单的形式编码在请求体中传递，例如：
POST /api/users HTTP/1.1 Content-Type: application/x-www-form-urlencoded name=john&age=30
表单编码适合传递简单的参数，但是不适合传递复杂的数据结构。
参数校验
RESTful API 请求参数的校验是保证 API 安全性和稳定性的重要环节。在处理 RESTful API 请求参数时，需要对参数进行校验，包括参数类型、参数长度、参数格式等方面。
参数类型
对于查询参数，需要校验参数的类型是否符合要求，例如：
const name = req.query.name;
if (typeof name !== 'string') {
throw new Error('Invalid parameter type: name');
}对于请求体参数，需要校验参数的类型是否符合要求，例如：
const user = req.body;
if (typeof user !== 'object' || Array.isArray(user)) {
throw new Error('Invalid parameter type: user');
}参数长度
对于查询参数和请求体参数，需要校验参数的长度是否符合要求，例如：
// www.javascriptcn.com code example
const name = req.query.name;
if (name.length > 20) {
throw new Error('Invalid parameter length: name');
}
const user = req.body;
if (user.name.length > 20) {
throw new Error('Invalid parameter length: user.name');
}参数格式
对于查询参数和请求体参数，需要校验参数的格式是否符合要求，例如：
// www.javascriptcn.com code example
const email = req.query.email;
if (!/^[\w-]+(\.[\w-]+)*@[\w-]+(\.[\w-]+)+$/.test(email)) {
throw new Error('Invalid parameter format: email');
}
const user = req.body;
if (!user.name || !user.age) {
throw new Error('Invalid parameter format: user');
}示例代码
以下是一个使用 Express 框架处理 RESTful API 请求参数的示例代码：
// www.javascriptcn.com code example
const express = require('express');
const app = express();
app.use(express.json());
app.use(express.urlencoded({ extended: true }));
app.get('/api/users', (req, res) => {
const name = req.query.name;
const age = parseInt(req.query.age);
if (typeof name !== 'string') {
return res.status(400).json({ error: 'Invalid parameter type: name' });
}
if (typeof age !== 'number' || isNaN(age)) {
return res.status(400).json({ error: 'Invalid parameter type: age' });
}
// TODO: 查询数据库
res.json({ name, age });
});
app.post('/api/users', (req, res) => {
const user = req.body;
if (typeof user !== 'object' || Array.isArray(user)) {
return res.status(400).json({ error: 'Invalid parameter type: user' });
}
if (!user.name || !user.age) {
return res.status(400).json({ error: 'Invalid parameter format: user' });
}
// TODO: 插入数据库
res.json(user);
});
app.listen(3000, () => {
console.log('Server started on port 3000');
});在示例代码中，使用了 Express 框架处理请求参数，并对参数进行了校验。在实际开发中，可以根据需要选择适合的框架和工具进行开发。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d3eba3a941bf713476dbfd