RESTful API 是现代 Web 应用程序的基石。它们需要尽可能简单、可靠和易于使用。但是，当你花了很多时间来构建 API，并且尝试访问它们时，你可能会遇到 404 错误。这种问题非常常见，但同时也可能是很棘手的。
什么是 RESTful API？
REST 是 Representational State Transfer 的缩写，它是一种 Web 服务架构风格和设计方法。它基于 HTTP 协议和各种资源、动词和状态的集合。Web 应用程序通常通过 RESTful API 提供服务接口。
RESTful API 是一组约定俗成的规则和准则，可确保 API 是可伸缩、高可用性且易于升级。它们包括：
- 每个资源由唯一的标识符表示；
- 使用标准 HTTP 方法（GET、PUT、POST、DELETE）以及资源的 URL 表示状态；
- 状态表示以 JSON、XML、HTML 等格式返回。
API 返回 404 的原因
当您的 RESTful API 返回 404 状态时，这通常表示请求的资源不存在。但是，这也可能是由其他问题引起的。
1. URL 错误
在 RESTful API 中，每个资源都应该拥有唯一标识符（URI）。如果请求的 URL 不正确，服务器将返回 404 状态。请检查 URL 是否拼写正确，是否包含正确的路径、查询参数等。
2. HTTP 方法错误
RESTful API 使用标准的 HTTP 方法（GET、PUT、POST、DELETE）来表示资源状态。如果 HTTP 方法不正确或不支持，服务器将返回 404 状态。例如，如果您尝试使用 PUT 方法访问只读资源，则服务器可能返回 404 状态。
3. 数据库中不存在该资源
当您的 API 从数据库中提取数据并返回它时，如果请求的资源在数据库中不存在，则服务器会返回 404 状态。请检查数据库中是否存在该资源，或尝试创造新的数据以确保它存在于数据库中。
4. 路径参数错误
有时，RESTful API 中需要使用路径参数。例如，您可能有一个路径为 api/users/:id 的终点。如果您请求 api/users 而不指定 ID，则服务器将返回 404 状态。请检查是否在请求路径中提供了正确的参数。
5. 静态文件处理
有时，Web 应用程序会使用单页应用程序，并将其托管在静态服务器上。在这种情况下，如果您请求的文件在静态文件夹中不存在，则服务器可能返回 404 错误。请确保您访问的路径是正确的，并且请求的文件确实存在于您的静态文件夹中。
如何解决 API 返回 404 的问题？
如果您的 RESTful API 返回 404 状态，那么无论原因是什么，都需要紧密检查。下面是一些解决方法：
1. 检查 URL
为了排除 URL 问题，请检查请求的 URL 是否正确，是否有拼写错误，是否包含正确的路径、查询参数等。
2. 检查 HTTP 方法
为了排除 HTTP 方法问题，请检查请求的 HTTP 方法是否正确或不受支持。
3. 检查数据库
为了确定数据库中是否存在该资源，请检查数据库是否存在该资源。如果不存在，请尝试在数据库中创建一条新的数据。
4. 检查路径参数
为了排除路径参数问题，请检查请求的路径参数是否正确。
5. 检查静态文件夹
为了排除静态文件夹问题，请检查所请求的文件是否确实存在于静态文件夹中，并且是否使用正确的路径访问。
示例代码
以下是一个使用 Node.js 和 Express 框架的简单示例代码，演示了如何检查路径参数和数据库中是否存在资源。
// javascriptcn.com 代码示例
const express = require('express')
const app = express()
const port = 3000
let data = [
{ name: 'Alice', age: 30 },
{ name: 'Bob', age: 25 },
{ name: 'Charlie', age: 35 }
]
// 获取所有用户数据
app.get('/api/users', (req, res) => {
res.json(data)
})
// 获取单个用户数据
app.get('/api/users/:id', (req, res) => {
const id = parseInt(req.params.id)
const user = data.find(user => user.id === id)
if (!user) {
return res.status(404).json({ message: 'User not found' })
}
res.json(user)
})
app.listen(port, () => {
console.log(`Server listening at http://localhost:${port}`)
})在上面的示例代码中：
/api/users路径返回所有用户数据。/api/users/:id路径需要一个路径参数 ID，并返回具有指定 ID 的用户数据。- 如果请求的 ID 不存在于数据中，服务器将返回 404 错误。
总结
通过遵循 RESTful API 设计准则和常见的错误排除建议，可以避免 API 返回 404 错误。如果发生这种情况，请检查 URL、HTTP 方法、数据库、路径参数和静态文件夹等问题，以及使用适当的状态代码和错误消息来传达错误原因。
来源：JavaScript中文网 ，转载请注明来源 本文地址：https://www.javascriptcn.com/post/652fda727d4982a6eb1113d4