RESTful API 是一种常见的 Web 服务架构，它的设计理念是基于 HTTP 协议的，将 Web 资源以标准化的方式通过 URI、HTTP 方法、HTTP 状态码等方式进行描述。它被广泛应用于现代 Web 应用程序中。但是，在实际开发中，很多开发者并没有很好地掌握 RESTful API 的设计原则和服务端错误与异常处理方式，本文旨在介绍 RESTful API 中常见的服务端错误与异常，为开发者提供指导和参考。
1. HTTP状态码
HTTP 是 RESTful API 中非常重要的组成部分，它提供了一种丰富的状态码来描述服务器处理请求的结果。对于客户端，理解这些状态码非常重要。下面是常见的 HTTP 状态码：
- 1XX: 信息状态码，表示服务器接受请求，需要请求者继续执行操作。
- 2XX: 成功状态码，表示服务器接受请求并成功处理。
- 3XX: 重定向状态码，表示请求完成需要进一步处理才能完成。
- 4XX: 客户端错误状态码，表示请求包含语法错误或无法完成请求。
- 5XX: 服务端错误状态码，表示服务器无法完成请求。
在下面的内容中，我们主要关注 4XX 和 5XX 状态码。
2. 服务器错误与异常
当客户端发出请求时，服务器可能会遇到各种各样的错误或异常，下面是常见的错误和异常：
2.1. 404 Not Found
当请求的资源不存在时，服务器应该返回 404 Not Found 状态码。
例如，当请求一个不存在的用户时，服务器将会返回下面的 JSON 响应：
{
"error": true,
"message": "User not found"
}2.2. 400 Bad Request
在请求参数、请求体或请求头字段不合法时，服务器应该返回 400 Bad Request 状态码。例如，请求缺少必要的参数时，服务器将会返回下面的 JSON 响应：
{
"error": true,
"message": "Missing parameter: name"
}2.3. 401 Unauthorized
当客户端未提供合法的认证信息或认证信息无效时，服务器应该返回 401 Unauthorized 状态码。
例如，在客户端发起请求时，若客户端没有提供有效的认证信息，服务器将会返回下面的 JSON 响应：
{
"error": true,
"message": "Authentication failed"
}2.4. 403 Forbidden
当客户端请求被服务端拒绝时，服务器应该返回 403 Forbidden 状态码。
例如，当客户端试图获取其他用户私有资源时，服务器将会返回下面的 JSON 响应：
{
"error": true,
"message": "Access denied"
}2.5. 405 Method Not Allowed
当客户端使用了不支持的 HTTP 方法时，应该返回 405 Method Not Allowed 状态码。
例如，当客户端使用 DELETE 方法请求某个资源时，但是该资源只支持 GET 和 POST 方法，服务器将会返回下面的 JSON 响应：
{
"error": true,
"message": "Method not allowed"
}2.6. 500 Internal Server Error
当服务器在处理请求时遇到错误或异常，应该返回 500 Internal Server Error 状态码。
例如，当服务器在处理请求时遇到未捕获的异常或非法的状态时，将会返回下面的 JSON 响应：
{
"error": true,
"message": "Internal server error"
}3. 总结
在使用 RESTful API 设计和开发时，我们需要注意处理服务端错误和异常。正确的处理方式可以让我们更好地维护服务，并使客户端有更好的使用体验。在实际开发中，开发者可以使用实际的例子，如向服务器发送一个不合法的请求，然后查看返回的状态码和响应内容，从而更好地理解 RESTful API 中的错误处理方式。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/6473f51c968c7c53b016ab1c
