RESTful API 是一种设计风格，它约束了 Web 应用程序中的资源如何被定义和操作。RESTful API 的核心概念是资源和操作，本文将详细介绍如何理解 RESTful API 中的资源和操作。
什么是资源
在 RESTful API 中，资源是指 Web 应用程序中的实体或对象。这些实体可以是任何东西，如用户、订单、商品等等。资源可以通过 URI（统一资源标识符）来唯一标识，URI 是一个字符串，用于标识资源的位置和名称。
例如，下面是一个表示用户资源的 URI：
https://api.example.com/users/123
这个 URI 表示一个名为 "123" 的用户资源，它位于 "https://api.example.com/users" 这个路径下。
什么是操作
在 RESTful API 中，操作是对资源的一种行为，例如获取、创建、更新和删除等。操作通常使用 HTTP 方法来表示，常用的有 GET、POST、PUT 和 DELETE 等。
例如，下面是一个使用 GET 方法获取用户资源的示例：
GET https://api.example.com/users/123
这个请求表示获取一个名为 "123" 的用户资源。
如何设计 RESTful API
在设计 RESTful API 时，需要考虑以下几个方面：
1. 使用名词表示资源
资源应该使用名词来表示，例如 "users"、"orders"、"products" 等。
2. 使用 HTTP 方法表示操作
操作应该使用 HTTP 方法来表示，例如 GET、POST、PUT 和 DELETE 等。
3. 使用 URI 表示资源
资源应该使用 URI 来表示，URI 应该是唯一的，例如 "https://api.example.com/users/123"。
4. 使用状态码表示操作结果
操作的结果应该使用 HTTP 状态码来表示，例如 200 表示成功，404 表示资源不存在，500 表示服务器错误等。
示例代码
下面是一个使用 Node.js 和 Express 框架实现的 RESTful API 示例：
// www.javascriptcn.com code example
const express = require('express');
const app = express();
const users = [
{ id: 1, name: 'Alice' },
{ id: 2, name: 'Bob' },
{ id: 3, name: 'Charlie' },
];
app.get('/users', (req, res) => {
res.json(users);
});
app.get('/users/:id', (req, res) => {
const id = parseInt(req.params.id);
const user = users.find(u => u.id === id);
if (user) {
res.json(user);
} else {
res.status(404).json({ error: 'User not found' });
}
});
app.post('/users', (req, res) => {
const user = req.body;
user.id = users.length + 1;
users.push(user);
res.status(201).json(user);
});
app.put('/users/:id', (req, res) => {
const id = parseInt(req.params.id);
const user = users.find(u => u.id === id);
if (user) {
Object.assign(user, req.body);
res.json(user);
} else {
res.status(404).json({ error: 'User not found' });
}
});
app.delete('/users/:id', (req, res) => {
const id = parseInt(req.params.id);
const index = users.findIndex(u => u.id === id);
if (index !== -1) {
users.splice(index, 1);
res.status(204).end();
} else {
res.status(404).json({ error: 'User not found' });
}
});
app.listen(3000, () => {
console.log('Server started on port 3000');
});这个示例实现了一个简单的用户管理系统，包括获取用户列表、获取指定用户、创建用户、更新用户和删除用户等操作。通过 URI 和 HTTP 方法来表示资源和操作，通过状态码来表示操作结果。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d4f6dba941bf7134937f56