简介
axiom-apis 是一个基于 axios 封装的 HTTP 请求库,它提供了简单易用的 API 和可扩展性,方便开发者在前端项目中进行 HTTP 请求。
安装
npm install axiom-apis
快速入门
使用 axiom-apis 前,你需要先实例化一个 http 对象:
import AxiomApis from 'axiom-apis'; const http = new AxiomApis();
然后,可以使用 http 对象来发送 HTTP 请求:
http.get('http://example.com/api/data') .then(res => { console.log(res.data); }) .catch(error => { console.error(error); });
以上代码会发送一个 GET 请求到 http://example.com/api/data,并将响应数据打印到控制台。
API
http.get(url [, config])
发送一个 GET 请求。
url
: String —— 请求地址。config
: Object —— 可选,请求配置对象。
返回一个 Promise 对象。
示例:
-- -------------------- ---- ------- --------------------- - -------- - ---------------- ------- - - ----- -- ------- - --- - - -- --------- -- - ---------------------- -- ------------ -- - --------------------- ---
http.post(url, data [, config])
发送一个 POST 请求。
url
: String —— 请求地址。data
: Object/String —— 请求数据,可以是一个普通对象或字符串。config
: Object —— 可选,请求配置对象。
返回一个 Promise 对象。
示例:
-- -------------------- ---- ------- ---------------------- - --- -- ----- ---- -- - -------- - ---------------- ------- - - ----- - -- --------- -- - ---------------------- -- ------------ -- - --------------------- ---
http.put(url, data [, config])
发送一个 PUT 请求。
url
: String —— 请求地址。data
: Object/String —— 请求数据,可以是一个普通对象或字符串。config
: Object —— 可选,请求配置对象。
返回一个 Promise 对象。
示例:
-- -------------------- ---- ------- ----------------------- - ----- ---- -- - -------- - ---------------- ------- - - ----- - -- --------- -- - ---------------------- -- ------------ -- - --------------------- ---
http.patch(url, data [, config])
发送一个 PATCH 请求。
url
: String —— 请求地址。data
: Object/String —— 请求数据,可以是一个普通对象或字符串。config
: Object —— 可选,请求配置对象。
返回一个 Promise 对象。
示例:
-- -------------------- ---- ------- ------------------------- - ----- ---- -- - -------- - ---------------- ------- - - ----- - -- --------- -- - ---------------------- -- ------------ -- - --------------------- ---
http.delete(url [, config])
发送一个 DELETE 请求。
url
: String —— 请求地址。config
: Object —— 可选,请求配置对象。
返回一个 Promise 对象。
示例:
-- -------------------- ---- ------- -------------------------- - -------- - ---------------- ------- - - ----- - -- --------- -- - ---------------------- -- ------------ -- - --------------------- ---
可配置项
http 对象的实例化可以传入一个配置对象,默认配置项如下:
-- -------------------- ---- ------- ----- ---- - --- ----------- -------- --- -- -- ---- --- -------- ------ -- ---------- ---------------- ------ -- ---------- ------ -------- - -- ----- ------- - --------------- ------------------ - - ---
每个请求方法也可以接收一个可选的配置对象,它的优先级高于实例化时的默认配置。
拦截器
axiom-apis 还提供了拦截器,可以在请求发送前和响应返回后做一些处理。
请求拦截器
-- -------------------- ---- ------- ----- ---- - --- ------------ ------------------------------------ -- - ------------- - - ------ ----------- ---------------- -- ------ ------- -- ----- -- - ------ ---------------------- ---
以上代码在发起请求时,会将 token 添加到请求参数中。
响应拦截器
-- -------------------- ---- ------- ----- ---- - --- ------------ --------------------------------------- -- - -- ------------------- --- ---- - -- ---- -------------------- - --------- - ------ --------- -- ----- -- - ------ ---------------------- ---
以上代码在接收到响应时,会判断返回数据的 code 是否是 401,如果是则跳转到登录页面。
来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/6005591a81e8991b448d68bc