https://github.com/uni-helper/axios-adapter

为 uni-app 打造的 axios 适配器，支持全平台
https://github.com/uni-helper/axios-adapter

axios-adapter http request uniapp-plugin

Last synced: about 2 months ago
JSON representation

为 uni-app 打造的 axios 适配器，支持全平台

• Host: GitHub
• URL: https://github.com/uni-helper/axios-adapter
• Owner: uni-helper
• Created: 2022-10-10T13:48:50.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-21T02:38:53.000Z (4 months ago)
• Last Synced: 2024-05-21T21:49:01.496Z (4 months ago)
• Topics: axios-adapter, http, request, uniapp-plugin
• Language: TypeScript
• Homepage:
• Size: 316 KB
• Stars: 25
• Watchers: 1
• Forks: 3
• Open Issues: 11
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

• awesome-uni-app - axios-adapter - helper/axios-adapter) - 一个用于 uni-app 的 Axios 适配器。 (Lib 工具库)

README

        


# @uni-helper/axios-adapter

> 适用于 Vue2 和 Vue3 的 uniapp Axios 适配器

## 安装

```

pnpm i @uni-helper/axios-adapter axios

```

## 使用

点击查看平台兼容性

| Vue2 | Vue3 |

| ---- | ---- |

| √    | √    |

| App                                      | 快应用 | 微信小程序 | 支付宝小程序 | 百度小程序 | 字节小程序 | QQ 小程序 |

| ---------------------------------------- | ------ | ---------- | ------------ | ---------- | ---------- | --------- |

| HBuilderX 3.4.8
app-vue
app-nvue | √      | √          | √            | √          | √          | √         |

| 钉钉小程序 | 快手小程序 | 飞书小程序 | 京东小程序 |

| ---------- | ---------- | ---------- | ---------- |

| √          | √          | √          | √          |

| H5-Safari | Android Browser | 微信浏览器(Android) | QQ 浏览器(Android) | Chrome | IE  | Edge | Firefox | PC-Safari |

| --------- | --------------- | ------------------- | ------------------ | ------ | --- | ---- | ------- | --------- |

| √         | √               | √                   | √                  | √      | √   | √    | √       | √         |

### 基本用法

```ts

import axios from 'axios'

import { createUniAppAxiosAdapter } from '@uni-helper/axios-adapter'

axios.defaults.adapter = createUniAppAxiosAdapter()

```

或者创建自定义实例

```ts

import axios from 'axios'

import { createUniAppAxiosAdapter } from '@uni-helper/axios-adapter'

const instance = axios.create({ adapter: createUniAppAxiosAdapter() })

```

### 与 [useAxios](https://vueuse.org/integrations/useAxios/) 一起使用

```ts

import axios from 'axios'

import { createUniAppAxiosAdapter } from '@uni-helper/axios-adapter'

axios.defaults.adapter = createUniAppAxiosAdapter()

const { data, isFinished } = useAxios('/posts')

```

### 上传和下载

```ts

// 下载

axios.download('/')

// or

axios.request({

  url: '/',

  method: 'download',

})

// 上传

axios.upload('/', new File([new Blob()], 'fake file'))

// or

axios.request({

  url: '/',

  method: 'upload',

  data: new File([new Blob()], 'fake file'),

})

```

### 小程序

自 axios 1.4.0 开始，axios 内部已经处理了小程序的兼容性问题

我要使用 `FormData` 和 `Blob` 对象

小程序没有 `FormData` 和 `Blob` 对象，

使用 `pnpm add miniprogram-formdata miniprogram-blob` 来安装对应的 polyfill，然后使用插件

```ts

// vite.config.js

import uniAxiosAdapter from '@uni-helper/axios-adapter/vite'

export default {

  plugins: [

    uniAxiosAdapter()

  ]

}

```

如果你使用的是 Vue CLI，改用 `@uni-helper/axios-adapter/webpack` 即可

### 版本

自 1.4.0 开始，请始终保持主版本号和次版本号与 axios 一致。例如当你安装了 1.5.1 版本时，你可以安装 axios 的 1.5.x 版本。

这样做的目的是始终支持最新的 axios。