npm 包 axiom-apis 使用教程

简介

axiom-apis 是一个基于 axios 封装的 HTTP 请求库,它提供了简单易用的 API 和可扩展性,方便开发者在前端项目中进行 HTTP 请求。

安装

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

快速入门

使用 axiom-apis 前,你需要先实例化一个 http 对象:

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

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

然后,可以使用 http 对象来发送 HTTP 请求:

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

以上代码会发送一个 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


猜你喜欢

  • npm 包 butter-assemble-exclude 使用教程

    在前端开发过程中,我们经常会用到各种各样的 npm 包来帮助我们提高开发效率。其中 butter-assemble-exclude 是一款非常实用的包,可以帮助我们在使用 assemble 时快速排除...

    2 年前
  • npm 包 bigone2000 使用教程

    bigone2000 是一个使用 Promise 和 WebSocket 通信的 BigONE API 客户端库,适用于 Node.js 环境和浏览器环境。通过 bigone2000,我们可以轻松地与...

    2 年前
  • NPM 包 git-linter 使用教程

    简介 Git 是开发者日常使用最为频繁的工具之一,而 git commit message 则是重要的开发文档,标准的 commit message 可以方便日后的维护和查阅。

    2 年前
  • npm 包 makeen-core 使用教程

    makeen-core 是一个用于构建 Node.js 应用程序的 npm 包。它提供了许多有用的工具、插件和扩展程序,这些功能使得您可以使用常规的 MVC 模式构建应用程序,并且使用该包的工具可以极...

    2 年前
  • npm 包 promise-polyfiller 使用教程

    什么是 promise-polyfiller promise-polyfiller 是一个用来解决旧版本浏览器不支持 Promise 的 npm 包。它能够补充旧版本浏览器不支持的 Promise A...

    2 年前
  • npm 包 react-native-nuance-text-to-speech 使用教程

    在 React Native 开发中,很多时候需要使用到语音合成技术,让 APP 能够自然地与用户进行交流。而 Nuance 的 Text-to-Speech 引擎被广泛应用于语音合成领域,因此,本篇...

    2 年前
  • npm 包 yijing 使用教程

    npm 包 yijing 使用教程 yijing 是一款基于 JavaScript 的 npm 包,用于实现对《易经》的解释和处理。它可以帮助前端程序员更加方便地应用《易经》相关的知识,达到更好的设计...

    2 年前
  • npm 包 @opensourcerefinery/osr-ascii-art 使用教程

    前言 ASCII 艺术,又叫字符艺术,是一种用 ASCII 字符来表现图像、图表和较为复杂的艺术作品的技术。在计算机图形的早期,ASCII 艺术是一种流行的方式,用于在计算机屏幕上表现图形。

    2 年前
  • npm 包 @rajkeshwar/ng-bootstrap 使用教程

    在前端开发的过程中,我们经常会用到许多工具和框架,其中的 npm 包是非常重要的一部分。本文将介绍一个强大的 UI 库,@rajkeshwar/ng-bootstrap,它是 Bootstrap 4 ...

    2 年前
  • npm包conquest-living-styleguide使用教程

    随着前端技术的不断发展,前端开发工程师需要快速构建出美观、规范的界面,同时保持开发效率和提高质量。在这个时代,样式库和组件库成为了前端开发的必备工具之一。而conquest-living-styleg...

    2 年前
  • npm 包 pushback 使用教程

    前言 在前端项目中,我们经常需要向数组中添加新元素。在这个过程中,我们可能会遇到一些问题,例如添加的元素类型不匹配,或者需要移除添加的元素。这时候,npm 包 pushback 可以帮助我们解决这些问...

    2 年前
  • npm 包 vue-morepage-cli 使用教程

    前言 随着 Vue.js 的逐渐普及,越来越多的前端开发人员开始偏好使用 Vue.js 来构建应用程序。而在实际开发中,一个常见的需求就是实现多页应用。但是,由于 Vue.js 本身是一个单页应用框架...

    2 年前
  • npm 包 flclover-proxy 使用教程

    在现代的应用程序开发中,前端开发工具的重要性越来越受到重视。其中,npm 包是前端开发中不可缺少的工具。npm 包可以帮助你管理工程中的依赖,提高工作效率。而 flclover-proxy 就是一个非...

    2 年前
  • npm 包 test-sig-library 使用

    npm 是一个 JavaScript 包管理器,允许开发者分享和重用代码。test-sig-library 是一个可以用来测试算法的 npm 包,在前端领域具有很高的实用价值。

    2 年前
  • npm 包 kronaby 使用教程

    介绍 kronaby 是一个支持跟踪用户活动的 npm 包。它可以跟踪用户的点击、浏览和搜索等活动,并将数据发送到指定的数据收集平台中。 安装 在使用 kronaby 之前,您需要先安装 Node.j...

    2 年前
  • npm 包 @iterables/all 使用教程

    概述 @iterables/all 是一款 npm 包,它提供了一个函数 all,可以接受类数组和迭代器作为参数,并将它们转换为迭代器。使用 all 函数,你可以轻松地对类数组和迭代器进行操作,比如过...

    2 年前
  • npm 包 @iterables/chain 使用教程

    在前端开发中,经常需要对数据进行处理,来满足业务需求。在这个过程中,我们可能需要对数据进行多个操作,例如筛选、排序、分组等等。如果使用传统的方式,就需要通过多个不同的方法来进行处理,不仅效率低下,而且...

    2 年前
  • npm 包 @iterables/any 使用教程

    近年来,JavaScript 的发展已经逐渐成为前端开发的主流。其中,npm 是一个很重要的工具,它可以让开发者轻松地找到对应的包、模块,快速构建自己的应用,并且不断优化和更新。

    2 年前
  • npm 包 @iterables/filter 使用教程

    在前端开发中,经常需要对数组进行筛选操作。而 npm 社区中的 @iterables/filter 包提供了一系列方便、高效的数组筛选方法,让我们可以更加快速、方便地完成筛选任务。

    2 年前
  • npm 包 @iterables/count 使用教程

    前言 在前端开发中,我们经常会需要对数组、map 和 set 等集合进行统计处理。今天,我们来介绍一款优秀的 npm 包——@iterables/count,它可以帮助我们更加方便高效地对集合进行计数...

    2 年前

相关推荐

    暂无文章