npm 包 axios-on-rails 使用教程

阅读时长 4 分钟读完

简介

axios-on-rails 是 axios 的一个 Rails 插件,使得在 Rails 应用中的数据请求更加方便,同时支持 CSRF 保护和自定义 header 参数。本文将为大家详细介绍如何使用 axios-on-rails 来发送请求。

安装

首先需要安装 axios 和 axios-on-rails 包:

配置

在应用的 JavaScript 文件中导入 axios 和 axios-on-rails:

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

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

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

下面是各参数的意义:

  • axiosOnRails.csrfParam:CSRF 保护时的参数名称,需要与 Rails 服务端配置的参数名称一致;
  • axiosOnRails.csrfToken:CSRF Token,通过调用 Rails.csrfToken() 方法获取;
  • axiosOnRails.header:自定义 header 参数;
  • axiosOnRails.namespace:API 版本配置。

使用

使用 axiosOnRails 发送请求时与 axios 基本一致,只需要调用对应的 HTTP 方法即可:

axiosOnRails 支持的 HTTP 方法有:

  • axiosOnRails.get(url[, config])
  • axiosOnRails.delete(url[, config])
  • axiosOnRails.head(url[, config])
  • axiosOnRails.options(url[, config])
  • axiosOnRails.post(url[, data[, config]])
  • axiosOnRails.put(url[, data[, config]])
  • axiosOnRails.patch(url[, data[, config]])

下面我们来看一个请求的参数配置示例:

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

在这个请求中,我们指定了 URL 参数(idname),同时定义了自定义的 header 参数(X-Custom-Header)。

总结

axios-on-rails 包使得 Rails 应用中的数据请求更加方便,同时支持 CSRF 保护和自定义 header 参数。在使用时需要先进行配置,然后就可以通过对应的 HTTP 方法来向服务端发送请求。

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

纠错
反馈