简介
api_client_shared_library 是一个基于 JavaScript 的 npm 包，旨在提供一个通用的 API 客户端库，可被用于不同的前端项目中。该库提供了常见的 API 请求方法和数据处理函数，并可以进行简单的配置，从而快速构建自己的 API 客户端。
安装
使用 npm 安装 api_client_shared_library
--- ------- ------------------------- ------
安装成功后，你就可以在你的项目中引入该库：
------ --------- ---- ----------------------------
基本使用
-- -- --- ----
-------------------------------------------------
-- ---- --- --
----- ---------- - --------------------------------- -
------- ------
---
-- -- --- -------
----------
-------
---------------- -- -
--------------------------- -- -- --- -----
--
-------------- -- -
--------------------- -- -- --- ------
---在上面的示例代码中，我们首先使用 setBaseUrl 方法配置了 API 的根路径，然后使用 createRequest 方法创建了一个 API 请求对象。通过 send 方法可以发送该请求，并在 then 方法中处理返回结果，在 catch 方法中处理错误。
API 请求方法
api_client_shared_library 提供了常见的 API 请求方法，包括 GET、POST、PUT、DELETE、HEAD、OPTIONS 等。使用这些方法可以轻松地构建 API 请求。
GET 请求
----------------- -- ------ -- ----------
使用 GET 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。params(object): API 请求的参数。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
----------------------- - ----- -- ------ --- ------------------------- -- - --------------------------- -- -- --- ----- --
POST 请求
------------------ -- ---- -- ----------
使用 POST 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。data(object): 请求参数的数据。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
------------------------ - ----- ------ ---- --- ------------------------- -- - --------------------------- -- -- --- ----- --
PUT 请求
----------------- -- ---- -- ----------
使用 PUT 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。data(object): 请求参数的数据。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
------------------------- - ----- ------ ---- --- ------------------------- -- - --------------------------- -- -- --- ----- --
DELETE 请求
-------------------- -- ----------
使用 DELETE 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
--------------------------------------------------- -- - --------------------------- -- -- --- ----- --
HEAD 请求
------------------ -- ----------
使用 HEAD 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
----------------------------------------------- -- - --------------------------- -- -- --- ----- --
OPTIONS 请求
--------------------- -- ----------
使用 OPTIONS 方法向指定 URL 发送一个 API 请求。
参数：
url(string): API 请求的 URL。options(object): 额外的请求选项。
返回值：一个请求对象，该对象可以使用 send 方法来发送请求。
示例：
-------------------------------------------------- -- - --------------------------- -- -- --- ----- --
API 请求对象
api_request 对象是一个具有所有请求方法的对象，可以使用请求对象创建 API 请求。
api_request.send()
-----------------
发送 API 请求并返回一个 Promise 对象，该对象会在请求完成后由 api_client_shared_library 处理。
示例：
--------------------------------- -- - --------------------------- -- -- --- ----- --
api_request.query()
------------------------
设置请求 Query 参数，该方法不影响 URL 部分。
参数：
params(object): Query 参数。
示例：
------------------ ----- -- ------ -- --
api_request.header()
---------------------- ------
设置请求 Header 参数。
参数：
key(string): Header 参数名。value(string): Header 参数值。
示例：
--------------------------------- -------------------
api_request.set()
------------------- ------
设置请求原始参数。
参数：
key(string): 参数名。value(string): 参数值。
示例：
------------------------- -----
api_request.sendData()
-------------------------
设置请求的原始数据。
参数：
data(string | object): 请求数据。
示例：
------------------------------------ ----- ------ ---- -- ---
api_request.params()
-------------------------
设置请求 URL 上的参数，并支持内嵌参数。
参数：
params(object): 需要将参数附加到 URL 上。
示例：
------------------- --- - --
api_request.json()
---------------------
设置请求数据的 Content-Type 为 application/json，并设置请求的数据。
参数：
data(string | object): 请求数据。
示例：
----------------- ----- ------ ---- -- --
api_request.formData()
-------------------------
设置请求数据的 Content-Type 为 multipart/form-data，并设置请求数据。
参数：
data(FormData): 请求数据。
示例：
----- -- - --- ---------- ----------------- ------ -----------------------
api_request.upload()
------------------------
上传文件。
参数：
files(File | File[] | object): 需要上传的文件。
示例：
----- ----- - -------------------------------------------- ----- ----- - ----------- ---------------------------------------- -- - --------------------------- -- -- --- ----- --
API 请求选项
timeout
------------------------------ -----
设置请求的超时时间（单位：毫秒），默认为 0，即无限等待。
withCredentials
-------------------------------------- -----
设置请求是否携带跨域调用的 cookie。
validateStatus
------------------------------------- -------- -------- - ------ ------ -- --- -- ------ - --- --
设置请求的状态码的验证方法。
transformRequest
--------------------------------------- --------- ------ -
----- -------- - --- ----------
--- ------ --- -- ----- -
-------------------- ----------
-
------ --------
---设置请求数据转换函数，该函数接收原始请求数据并返回转换后的请求数据。
transformResponse
---------------------------------------- --------- ------ - ------ ---------------- ---
设置响应数据转换函数，该函数接收原始响应数据并返回转换后的响应数据。
baseURL
------------------------------ ---------------------------
设置 API 的根路径。
总结
api_client_shared_library 为前端项目提供了一个通用的 API 客户端库，减少了对 API 调用的重复代码，并可以进行简单的配置，从而快速构建自己的 API 客户端。在常见的 API 请求方法和数据处理函数使用之外，还提供了请求发送前的预处理选项，可以方便地满足不同项目的需求。它的简单易用性和高度可定制化为前端开发人员提供了强大的支持，是一个值得学习和使用的 npm 包。
来源：JavaScript中文网 ，转载请联系管理员！ 本文地址：https://www.javascriptcn.com/post/6005609581e8991b448deca7