RESTful API 是一种常用的 Web API 设计风格，它使用 HTTP 协议定义了一组标准的请求方法和响应状态码，以及一种统一的资源表示方式。在开发 RESTful API 时，错误处理是一个非常重要的问题。正确地处理错误可以提高 API 的可用性和易用性，同时也可以提高开发者和用户的体验。
本文将介绍 RESTful API 中如何处理人性化的错误提示消息。我们将探讨以下几个方面：
- 错误响应的格式
- 错误码的设计
- 错误消息的本地化
- 错误消息的提示方式
1. 错误响应的格式
RESTful API 中的错误响应应该符合统一的格式，以便客户端能够正确地解析和处理。一般来说，错误响应应该包含以下信息：
- 状态码：HTTP 响应状态码，表示请求的处理结果。常见的状态码包括 200、400、401、403、404、500 等。
- 错误码：自定义的错误码，用于标识具体的错误类型。错误码应该是数字类型，可以根据需要进行扩展和细分。
- 错误消息：人性化的错误提示消息，用于说明错误的原因和解决方法。错误消息应该是字符串类型，可以根据需要进行本地化。
下面是一个示例错误响应的格式：
{
"code": 10001,
"message": "用户名或密码错误"
}2. 错误码的设计
错误码的设计应该遵循一定的规则和约定，以便客户端能够正确地处理错误。一般来说，错误码应该具有以下特点：
- 前缀：错误码应该有一个固定的前缀，用于区分不同的错误类型。例如，HTTP 错误码的前缀是 4xx 或 5xx。
- 数字：错误码应该是数字类型，便于客户端进行判断和处理。
- 细分：错误码应该根据需要进行细分，以便客户端能够更准确地处理错误。例如，HTTP 错误码中的 404 表示资源不存在，而 405 表示请求方法不允许。
下面是一个示例错误码的设计：
| 错误码 | 错误消息 | 说明 |
|---|---|---|
| 40001 | 参数错误 | 请求参数不合法或缺少必要参数 |
| 40002 | 授权失败 | 请求未经授权或授权已过期 |
| 40401 | 资源不存在 | 请求的资源不存在或已被删除 |
| 50001 | 服务器错误 | 服务器内部错误或未知错误 |
3. 错误消息的本地化
错误消息的本地化是指将错误消息翻译成多种语言，以便不同语言的用户能够正确地理解错误提示。在 RESTful API 中，错误消息的本地化可以通过以下方式实现：
- 多语言支持：API 应该支持多种语言，例如中文、英文、日文等。客户端可以通过请求头或查询参数指定语言。
- 错误消息文件：API 应该提供一个错误消息文件，其中包含了所有错误消息的翻译。客户端可以根据错误码和语言来查找对应的错误消息。
下面是一个示例错误消息文件：
// www.javascriptcn.com code example
{
"zh-CN": {
"40001": "请求参数不合法或缺少必要参数",
"40002": "请求未经授权或授权已过期",
"40401": "请求的资源不存在或已被删除",
"50001": "服务器内部错误或未知错误"
},
"en-US": {
"40001": "Invalid or missing request parameters",
"40002": "Unauthorized or expired authorization",
"40401": "The requested resource does not exist or has been deleted",
"50001": "Internal server error or unknown error"
}
}4. 错误消息的提示方式
错误消息的提示方式应该考虑到客户端的使用场景和用户体验。一般来说，错误消息可以通过以下方式提示：
- HTTP 响应头：错误消息可以作为 HTTP 响应头中的一个字段返回。客户端可以通过解析响应头来获取错误消息。
- HTTP 响应体：错误消息可以作为 HTTP 响应体中的一个字段返回。客户端可以通过解析响应体来获取错误消息。
- 弹窗提示：错误消息可以通过弹窗提示的方式显示。这种方式通常用于 Web 应用程序或移动应用程序中。
- 日志记录：错误消息可以通过日志记录的方式保存。这种方式通常用于服务器端应用程序中。
下面是一个示例代码，演示了如何在 Node.js 中实现 RESTful API 的错误处理：
// www.javascriptcn.com code example
const express = require('express');
const app = express();
// 处理 404 错误
app.use((req, res, next) => {
res.status(404).json({
code: 40401,
message: 'The requested resource does not exist or has been deleted'
});
});
// 处理其他错误
app.use((err, req, res, next) => {
console.error(err.stack);
res.status(500).json({
code: 50001,
message: 'Internal server error or unknown error'
});
});
app.listen(3000, () => {
console.log('Server started on port 3000');
});在上面的代码中，我们使用了 Express 框架来处理 RESTful API 的错误。当请求的资源不存在时，我们返回了一个 404 状态码和对应的错误消息。当其他错误发生时，我们将错误消息记录到控制台，并返回一个 500 状态码和对应的错误消息。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d2bd49a941bf713455918e