RESTful API 使用过程中遇到的坑

阅读时长 6 分钟读完

引言

REST(Representational State Transfer)是一种设计风格,它是一种架构风格,不是标准,它是对 HTTP 协议的应用和扩展。RESTful API 通常使用 HTTP 协议的 GET、POST、DELETE 和 PUT 方法来处理资源。使用 RESTful API 可以让前端与后端进行便捷的通信,但在使用的过程中也会遇到一些坑点,这篇文章将从以下几个方面来介绍 RESTful API 使用过程中遇到的问题:资源定位、HTTP 方法、状态码、安全、缓存。

资源定位

RESTful API 是将资源抽象成资源名,通过 HTTP 的方法来对资源进行操作。资源的 URI 应该没有任何命令与动词,即只用名词表示资源。在进行 RESTful API 资源定位的时候,可能会遇到 URI 并不清晰的问题。举个例子,比如一个用户管理的 API,使用 URI 为 /users,但是如果需要查看单个用户的数据,应该怎么拼接 URI 呢?

常见的做法是添加一些 ID,比如 /users/1/users/2。但如果使用这种方法的话,可能会因为访问的数据不存在或者已被删除而出现 404 状态码,或者还会因为重复、格式不正确等问题而出现其他错误。所以更好的方法是将资源链接到唯一的可浏览的位置上,在用户区分资源时,可以使用某些打破冲突的方式。

HTTP 方法

HTTP 协议是 RESTful API 中最重要的协议。在进行 HTTP 请求的时候,需要正确地使用 HTTP 方法。比如,当需要向服务器添加新的资源时,应该使用 POST 方法,而不是 GET 方法。如果使用 GET 进行新增操作,那么将会发生两个问题:一是浏览器会将这个操作添加到浏览历史中,二是这个操作可能会被搜索引擎从 URL 中获取,导致插入了重复的数据。

HTTP 方法还有一个常见的坑点,就是在进行 DELETE 操作的时候,是否需要返回删除的数据。在 RESTful API 中,推荐的做法是在响应的主体中返回被删除的资源,不过这样做也存在安全方面的考虑。

状态码

HTTP 状态码是 RESTful API 中的一个关键概念。每个 HTTP 响应都需要带上一个状态码,来表示请求成功或者失败的原因。以下是一些常见的 HTTP 状态码:

  • 200 OK:表示请求成功。

  • 404 Not Found:表示请求的资源不存在。

  • 401 Unauthorized:表示请求未经授权。

  • 500 Server Error:表示服务器内部错误。

使用状态码的时候,需要注意以下几点:

第一,尽可能使用合适的状态码。比如,在使用 POST 方法添加新资源的时候,应该使用 201 Created 状态码。另外,在出现错误的时候,应该使用具有常见含义的状态码,并在响应的主体中包含错误的描述。

第二,在使用状态码时,应该考虑前端的解析能力,以便更好地进行错误提示。比如,在使用 400 Bad Request 状态码时,响应的主体应该加入错误描述。

安全

在 RESTful API 的使用中,安全是一个不可缺少的问题。为了保证数据的安全性,RESTful API 可以使用以下几种安全方式:

1.验证与授权

使用验证与授权的方式是 RESTful API 推荐的安全方式。在使用 RESTful API 时,需要通过用户名和密码的方式验证用户的身份,确保只有合法的用户才能进行资源操作。同时也可以根据用户的权限,授权给用户访问对应的资源。

2.加密

使用加密方式可以使信息在传输过程中不被窃取。常见的加密方式包括 HTTPS 和 SSL,可以在客户端和服务器之间进行安全通信。

缓存

在进行 RESTful API 资源访问时,可能会遇到一个性能问题,就是缓存。使用缓存可以减少对服务器的请求次数,提升性能。但是,在对缓存进行使用时,需要注意以下几点:

  • 第一,使用可重复的缓存控制机制,比如 Last-Modified 和 ETag。这些可以避免请求中包含不必要的数据,节约下行带宽,并避免了服务端数据的重复计算。

  • 第二,使用正确的缓存策略。缓存策略可以控制页面的缓存时间和缓存方式。在页面过期或者过期时间达到时,可以通过服务器再次进行访问。

示例代码

-- -------------------- ---- -------
-- ------
-------- ------------ ------- -------- ----- -
    -- --------
    ------ --- ----------------- ------- -- -
        ----- --- - --- -----------------
        ---------------- ---- ------ -- --
        ---------------------- -- --------------------------------- ----------------
        ---------- - ---------- -
            -- ----
            -- ----------- -- --- -- ---------- - ---- -
                ----------------------
            - ---- -
                -- ----
                --------
                    ------- -----------
                    ----------- --------------
                ---
            -
        --
        ----------- - ---------- -
            --------
                ------- -----------
                ----------- --------------
            ---
        --
        ---------------
    ---
-

-- -----------
----------------- ------ -- ---- --------------- ------ ------------------ ---
  ---------- -- -
    ------------------
  --
  ------------ -- -
    ---------------------
  ---

总结

本文围绕 RESTful API 在使用过程中需要注意的问题展开了讲解,从资源定位、HTTP 方法、状态码、安全、缓存等方面进行了介绍。使用 RESTful API 可以极大地提高前端与后端之间的通信效率,但在使用的过程中也要注意数据安全,以防止数据泄露或者被篡改。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/64d4e974b5eee0b525cc0c5d

纠错
反馈