什么是 RESTful API？
RESTful API 是一种符合 REST 架构风格的 API 设计方式。REST 是 Representational State Transfer （表述性状态转移）的缩写，是一种轻量级的架构风格，常用于构建网络应用程序。
RESTful API 的特点：
- 基于 HTTP 协议
- URI 表示资源
- 支持多种数据格式（JSON、XML 等）
- 支持 HTTP 方法（GET、POST、PUT、DELETE 等）
如何构建 RESTful API？
1. 设计 URI
URI 是 RESTful API 的核心部分，它应该清晰、简洁、易于理解。URI 应该表示一个资源的标识，而不是一个行为。URI 应该符合以下几个规则：
- URI 应该使用名词而不是动词
- URI 中的名词应该是复数形式
- URI 中不应该出现动态参数（比如 /users?id=1）
2. 使用 HTTP 方法
RESTful API 使用 HTTP 方法表示不同的操作类型：
- GET：获取资源
- POST：创建资源
- PUT：更新资源
- DELETE：删除资源
使用 HTTP 方法既能提高 API 的可读性，也能保持 API 的幂等性（即执行相同操作多次，结果都相同）。
3. 返回状态码
RESTful API 应该返回合适的状态码。下面是几个常用的状态码和意义：
- 200 OK：请求成功
- 201 Created：创建资源成功
- 400 Bad Request：请求参数有误
- 404 Not Found：请求的资源不存在
- 500 Internal Server Error：服务器端错误
4. 返回数据格式
RESTful API 应该支持多种数据格式（JSON、XML 等），默认可以使用 JSON 格式。同时，API 返回的数据应该是经过合适的格式化、过滤、排序等处理的。
示例代码
下面是一个使用 Node.js 和 Express 框架构建的 RESTful API 示例代码（假设我们要管理用户）：
// javascriptcn.com 代码示例
// 引入 Express 框架
const express = require('express')
const app = express()
// 假设这里有一个包含所有用户信息的数组
const users = [
{ id: 1, name: '张三', age: 20 },
{ id: 2, name: '李四', age: 22 },
{ id: 3, name: '王五', age: 25 },
]
// 获取所有用户信息
app.get('/users', (req, res) => {
res.json(users)
})
// 获取指定 id 的用户信息
app.get('/users/:id', (req, res) => {
const id = req.params.id
const user = users.find(item => item.id === +id)
if (!user) {
res.status(404).json({ message: '用户不存在' })
} else {
res.json(user)
}
})
// 创建新的用户
app.post('/users', (req, res) => {
const newUser = req.body
newUser.id = users[users.length - 1].id + 1
users.push(newUser)
res.status(201).json({ message: '创建用户成功', user: newUser })
})
// 更新指定 id 的用户信息
app.put('/users/:id', (req, res) => {
const id = req.params.id
const user = users.find(item => item.id === +id)
if (!user) {
res.status(404).json({ message: '用户不存在' })
} else {
Object.assign(user, req.body)
res.json({ message: '更新用户成功', user })
}
})
// 删除指定 id 的用户
app.delete('/users/:id', (req, res) => {
const id = req.params.id
const index = users.findIndex(item => item.id === +id)
if (index < 0) {
res.status(404).json({ message: '用户不存在' })
} else {
users.splice(index, 1)
res.json({ message: '删除用户成功' })
}
})
// 启动服务器
app.listen(3000, () => {
console.log('Server started')
})总结
RESTful API 是一种常用的 API 设计方式，它可以提高 API 的可读性、可用性和可维护性。我们应该遵循 RESTful API 的设计规则，设计出清晰、简洁、易于理解的 API。同时，我们也要使用合适的工具和框架来支持 RESTful API 的开发。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/65421add7d4982a6ebbc11b1