Home > @zero-dim/request > AlAxios

AlAxios class

Axios 请求封装类

Signature:

export declare class AlAxios

Remarks

基于 Axios 的 HTTP 请求封装，提供以下功能： - 统一的请求拦截器和响应拦截器 - 自动处理 token 认证 - 支持请求加载动画 - 统一的错误处理和提示 - 支持自定义配置项

Example 1

基础用法：

import { AlAxios } from '@zero-dim/request'

const request = new AlAxios({
  requestOptions: {
    // 是否携带 token
    withToken: true,
    // 是否显示加载动画
    isShowLoading: true,
    // 是否显示成功提示
    isShowSuccessMessage: true
  }
})

// GET 请求
const data = await request.get('/api/users', { id: 1 })

// POST 请求带配置
const result = await request.post('/api/user',
  { name: 'John' },
  {
    isShowLoading: true,
    loadingMessageText: '保存中...',
    successMessageText: '保存成功！'
  }
)

Example 2

完整配置示例：

const axios = new AlAxios({
  baseURL: 'https://api.example.com',
  timeout: 10000,
  headers: {
    'Content-Type': 'application/json'
  },
  requestOptions: {
    // 请求配置
    withToken: true,
    isShowLoading: true,
    loadingMessageText: '加载中...',
    isShowSuccessMessage: true,
    successMessageText: '操作成功',
    isShowErrorMessage: true,
    errorMessageText: '操作失败',
    // 是否将参数拼接到url
    joinParamsToUrl: false,
    // 自定义headers
    headers: {
      'X-Custom-Header': 'custom'
    }
  }
})

Constructors

Constructor	Modifiers	Description
(constructor)(options)		Constructs a new instance of the AlAxios class

Properties

Property	Modifiers	Type	Description
loading		ReturnType<typeof AlLoadingService> | null	加载动画实例

Methods

Method	Modifiers	Description
get(url, params, options)		发送 GET 请求
getAxios()		获取 Axios 实例
post(url, data, options)		发送 POST 请求
put(url, data, options)		发送 PUT 请求
remove(url, data, options)		发送 DELETE 请求
request(config, options)		发送 HTTP 请求