RESTful API 是一种常用的 Web API 设计风格，它通过 HTTP 协议提供对资源的访问和操作。在设计 RESTful API 时，HTTP 头部是一个重要的组成部分，它可以用于传递各种信息，包括认证、缓存、内容类型等。本文将介绍 RESTful API 中的 HTTP 头部设计，帮助开发者更好地设计和使用 RESTful API。
常用的 HTTP 头部
Accept
Accept 头部用于指定客户端能够接收的响应内容类型。在 RESTful API 中，常用的响应内容类型包括 JSON、XML、HTML 等。例如，客户端可以使用以下代码指定接收 JSON 格式的响应：
Accept: application/json
Content-Type
Content-Type 头部用于指定请求或响应的内容类型。在 RESTful API 中，常用的请求或响应内容类型包括 JSON、XML、HTML 等。例如，客户端可以使用以下代码指定发送 JSON 格式的请求：
Content-Type: application/json
Authorization
Authorization 头部用于传递认证信息，通常用于保护 RESTful API 的访问。在 RESTful API 中，常用的认证方式包括基本认证、OAuth2 认证等。例如，客户端可以使用以下代码发送基本认证信息：
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Cache-Control
Cache-Control 头部用于控制缓存的行为，可以指定缓存的有效期、是否允许缓存等。在 RESTful API 中，通常使用 Cache-Control 头部来控制响应的缓存行为。例如，服务器可以使用以下代码指定响应不允许缓存：
Cache-Control: no-cache
ETag
ETag 头部用于标识响应内容的版本，通常用于支持缓存验证。在 RESTful API 中，服务器可以使用 ETag 头部来标识响应内容的版本，客户端可以使用 If-None-Match 头部来验证响应是否有更新。例如，服务器可以使用以下代码生成 ETag：
ETag: "686897696a7c876b7e"
Last-Modified
Last-Modified 头部用于标识响应内容的最后修改时间，通常用于支持缓存验证。在 RESTful API 中，服务器可以使用 Last-Modified 头部来标识响应内容的最后修改时间，客户端可以使用 If-Modified-Since 头部来验证响应是否有更新。例如，服务器可以使用以下代码指定响应的最后修改时间：
Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT
HTTP 头部的设计指导
在设计 RESTful API 时，HTTP 头部的设计应该遵循以下原则：
易于理解
HTTP 头部应该使用易于理解的名称和值，避免使用过于复杂的结构和语法。例如，使用简单的字符串表示内容类型，而不是使用 MIME 类型。
易于扩展
HTTP 头部应该支持扩展，允许用户自定义头部和值。例如，使用 X- 开头的头部表示用户自定义头部。
安全性考虑
HTTP 头部应该考虑安全性，避免传递敏感信息。例如，避免在 URL 中传递认证信息，而应该使用 Authorization 头部传递认证信息。
缓存控制
HTTP 头部应该支持缓存控制，确保响应可以被正确地缓存和验证。例如，使用 Cache-Control 头部控制缓存行为，使用 ETag 和 Last-Modified 头部支持缓存验证。
示例代码
以下是一个示例 RESTful API 的 HTTP 头部设计：
GET /api/users/123 HTTP/1.1 Host: example.com Accept: application/json Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c Cache-Control: max-age=3600
在上面的示例中，客户端向服务器请求获取 ID 为 123 的用户信息，指定接收 JSON 格式的响应，使用 OAuth2 认证方式发送认证信息，允许响应被缓存 3600 秒。
来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/67d3e3b8a941bf7134762e4c
