Restful API 设计规范

Moment
1,123 阅读11分钟

RESTful API（Representational State Transfer API）是一种设计风格的网络接口，用于网络应用之间的交互。REST 是一组架构原则和约束条件，而不是一种标准或协议。当一个 Web 服务是“RESTful”时，它遵循 REST 的原则，提供了一种高效、可靠、可扩展的网络服务。

在 RESTful 服务中，每个请求都应包含所有必要的信息来处理该请求。服务器不应保留任何客户端请求的状态信息。

RESTful 架构可能由多层组成，每一层可以执行特定的功能。这样的结构允许构建更加复杂和强大的应用程序。

一、URI 设计

在 RESTful API 设计中，URL（统一资源定位符）通常代表资源（宾语），而 HTTP 方法（如 GET, POST, PUT, DELETE 等）代表对这些资源的操作（动词）。这种设计风格强调资源的状态和表述，而不是动作。

1.1 动词 + 宾语 动词通常就是五种 HTTP 方法，对应 CRUD 操作。

  • GET：读取（Read）

  • POST：新建（Create）

  • PUT：更新（Update）

  • PATCH：更新（Update），通常是部分更新

  • DELETE：删除（Delete）

根据 HTTP 规范，动词一律大写。

1.2 宾语必须是名词

下面是优化后的文章内容，调整了表述的流畅性和逻辑性：

在设计 API 时，URL（即统一资源定位符）通常代表某一资源，作为 HTTP 动词作用的对象。根据 RESTful 设计原则，URL 应该是名词而非动词，因为它代表的是“资源”的集合或单个实例，而不是操作。

错误的示例：

  • /getAllCars

  • /createNewCar

  • /deleteAllRedCars

这些 URL 包含了动词（如 get、create、delete），它们描述了操作行为，而不是资源本身。这样设计不符合 RESTful 的语义规范。

正确的做法：

URL 应该专注于描述资源而非操作，以下是符合规范的 URL 设计示例：

  • /users：表示用户的集合

  • /users/123：表示具有特定 ID（123）的单个用户

在上面的示例中，/users 和 /users/123 都是名词，分别代表用户的集合和特定用户资源。这样设计的 URL 便于理解并符合 RESTful 的资源导向原则。

通过遵循这种命名规范，我们可以确保 API 路径清晰、一致，且便于理解和维护。

1.3 复数 URL

使用复数形式的 URL 通常是为了保持一致性和直观性，因为它们通常表示资源的集合。

当你的 URL 指向资源的集合时，使用复数名词。例如，使用 /users 而不是 /user 来表示所有用户的集合。

即使是指向单个资源的 URL，也建议使用复数形式。例如，/users/123 表示 ID 为 123 的用户。这样做是为了保持 URL 的一致性。

当资源存在层级关系时，URL 应该反映这种结构。例如，/users/123/posts 可以表示用户 123 的帖子集合。

1.4 避免多级 URL

常见的情况是，资源需要多级分类，因此很容易写出多级的 URL，比如获取某个作者的某一类文章。

GET /authors/12/categories/2

这种 URL 不利于扩展，语义也不明确，往往要想一会，才能明白含义。更好的做法是，除了第一级，其他级别都用查询字符串表达。

GET /authors/12?categories=2

下面是另一个例子，查询已发布的文章。你可能会设计成下面的 URL。

查询字符串的写法明显更好。

GET /articles?published=true

二、状态码

2.1 状态码必须精确

客户端的每一次请求，服务器都必须给出回应。回应包括 HTTP 状态码和数据两部分。 HTTP 状态码就是一个三位数，分成五个类别。

  • 1xx：相关信息

  • 2xx：操作成功

  • 3xx：重定向

  • 4xx：客户端错误

  • 5xx：服务器错误

这五大类总共包含 100 多种状态码，覆盖了绝大部分可能遇到的情况。每一种状态码都有标准的（或者约定的）解释，客户端只需查看状态码，就可以判断出发生了什么情况，所以服务器应该返回尽可能精确的状态码。

API 不需要 1xx 状态码，下面介绍其他四类状态码的精确含义。

2.2 2xx 状态码

不同的 HTTP 请求方法应返回相应的状态码，以指示请求的结果。虽然 200 OK 表示一般的成功，但不同的方法有更精确的状态码。

  • GET: 200 OK：表示请求成功并返回资源。

  • POST: 201 Created：表示成功创建了新资源，响应中通常会包含新资源的 URI。

  • PUT: 200 OK 或 204 No Content：完全更新资源时使用，若返回内容则为 200，没有内容则使用 204。

  • PATCH: 200 OK 或 204 No Content：部分更新资源时使用，和 PUT 类似，204 表示没有返回内容。

  • DELETE: 204 No Content：表示资源已被成功删除，通常没有返回内容。

  • 202 Accepted：表示请求已被接受，服务器尚未处理。适用于异步操作。

  • 206 Partial Content：表示部分内容返回，通常用于下载大文件时，客户端请求部分数据。服务器会根据请求头中的 Range 字段返回资源的指定部分。

3xx 状态码

API 用不到 301 状态码（永久重定向）和 302 状态码（暂时重定向，307 也是这个含义），因为它们可以由应用级别返回，浏览器会直接跳转，API 级别可以不考虑这两种情况。 API 用到的 3xx 状态码，主要是 303 See Other，表示参考另一个 URL。它与 302 和 307 的含义一样，也是"暂时重定向"，区别在于 302 和 307 用于 GET 请求，而 303 用于 POST、PUT 和 DELETE 请求。收到 303 以后，浏览器不会自动跳转，而会让用户自己决定下一步怎么办。下面是一个例子。

HTTP/1.1 303 See Other
Location: /api/orders/12345

4xx 状态码

4xx 状态码表示客户端错误，主要有下面几种。 400 Bad Request：服务器不理解客户端的请求，未做任何处理。 401 Unauthorized：用户未提供身份验证凭据，或者没有通过身份验证。 403 Forbidden：用户通过了身份验证，但是不具有访问资源所需的权限。 404 Not Found：所请求的资源不存在，或不可用。 405 Method Not Allowed：用户已经通过身份验证，但是所用的 HTTP 方法不在他的权限之内。 410 Gone：所请求的资源已从这个地址转移，不再可用。 415 Unsupported Media Type：客户端要求的返回格式不支持。比如，API 只能返回 JSON 格式，但是客户端要求返回 XML 格式。 422 Unprocessable Entity ：客户端上传的附件无法处理，导致请求失败。 429 Too Many Requests：客户端的请求次数超过限额。

5xx 状态码

5xx 状态码表示服务端错误。一般来说，API 不会向用户透露服务器的详细信息，所以只要两个状态码就够了。 500 Internal Server Error：客户端请求有效，服务器处理时发生了意外。 503 Service Unavailable：服务器无法处理请求，一般用于网站维护状态。

三、服务器回应

3.1 不要返回纯本文

API 返回的数据格式，不应该是纯文本，而应该是一个 JSON 对象，因为这样才能返回标准的结构化数据。所以，服务器回应的 HTTP 头的 Content-Type 属性要设为 application/json。

客户端请求时，也要明确告诉服务器，可以接受 JSON 格式，即请求的 HTTP 头的 ACCEPT 属性也要设成 application/json。下面是一个例子。

GET /orders/2 HTTP/1.1
Accept: application/json

3.2 发生错误时，不要返回 200 状态码

有一种不恰当的做法是，即使发生错误，也返回 200 OK 状态码，并将错误信息放在响应体中。这样的做法会导致客户端必须解析响应体才能知道请求是否失败，丧失了状态码的意义。

例如，下面的例子就是不推荐的做法：

HTTP/1.1 200 OK
Content-Type: application/json
{
  "status": "failure",
  "data": {
    "error": "Expected at least two items in list."
  }
}

在这个例子中，尽管请求失败，服务器依然返回了 200 OK 状态码。客户端必须在响应体中查找 "status": "failure"，才能得知操作失败。这样做不仅不符合 RESTful 的设计原则，也使得错误处理变得复杂且容易出错。

状态码应当反映请求的执行结果，错误的发生应该通过合适的状态码来传递给客户端，同时，具体的错误信息可以放在响应体中。例如，当请求无效时，应该返回 400 Bad Request 状态码，错误信息可以通过 JSON 格式的响应体返回：

HTTP/1.1 400 Bad Request
Content-Type: application/json
{
  "error": "Invalid payload.",
  "detail": {
    "surname": "This field is required."
  }
}

在这个正确的例子中，状态码 400 明确表示请求无效，而响应体则包含了详细的错误信息，帮助客户端理解具体的错误原因。

3.3 提供链接

在 RESTful 风格的 API 中，返回链接是一种常见的做法，这通常涉及到使用超媒体链接（Hypermedia as the Engine of Application State，或 HATEOAS）。这些链接提供了一种方式来动态地引导客户端到应用程序的其他部分，增强了 API 的可发现性和自描述性。

以下就有一些返回链接的常见方式：

  1. 使用 HAL（Hypertext Application Language）：

    • HAL 是一种流行的超媒体格式，可以用来表示资源之间的链接。

    • 在 JSON 响应中，HAL 使用 _links 属性来包含相关链接。

    {
  "id": 1,
  "name": "Example",
  "_links": {
    "self": {
      "href": "http://api.example.com/resource/1"
    },
    "related": {
      "href": "http://api.example.com/resource/2"
    }
  }
}

  2. 直接在 JSON 中包含链接：

{
  "id": 1,
  "name": "Example",
  "links": {
    "self": "http://api.example.com/resource/1",
    "related": "http://api.example.com/resource/2"
  }
}

3.4 内容返回

在 RESTful API 设计中，POST 请求用于创建新的资源。关于创建成功后是否返回内容，这取决于具体的实现和需求，但通常有两种常见的做法：

  1. 返回创建的资源： 在成功创建资源后，通过返回 201 Created 状态码和包含新资源详细信息的响应，可以直接向客户端提供所需数据。此外，响应通常会包括一个 Location 响应头，指明新创建资源的 URI。这种方法的优点是它为客户端即时提供了新资源的完整信息，从而避免了客户端需再次发起 GET 请求来获取这些信息的额外步骤。这不仅提高了效率，还增强了用户体验。

    HTTP/1.1 201 Created
Location: /resources/123
Content-Type: application/json
{
"id": 123,
"name": "New Resource",
// ... 更多资源详情
}

  2. 不返回具体内容： 在 RESTful API 设计中，对于 POST 请求成功创建新资源，有时候选择仅返回表示成功的响应而不包含新资源的详细信息。这种情况下，通常会返回 201 Created 或 204 No Content 状态码，并在响应头中包含 Location 字段，指向新创建资源的 URI。这种做法的优点在于其简洁性：当新资源的详细信息较大或不是立即必需时，这样做可以减少数据传输。此外，客户端可以根据自己的需要决定是否后续获取这些资源详情，从而提供了更大的灵活性和效率。

    HTTP/1.1 201 Created
Location: /resources/123

总结

RESTful 是一种基于 HTTP 协议的 Web 服务设计风格，它强调资源的表述和无状态交互。通过使用标准的 HTTP 方法（如 GET、POST、PUT、DELETE）和状态码，RESTful 架构提供了一种简洁、高效且易于理解和实现的方式来构建网络应用。这种风格使得 Web 服务变得更加可伸缩、灵活且易于维护。

avatar
文章
阅读
粉丝