diff --git a/README.md b/README.md
index 3f9f9cd..2e55ae4 100644
--- a/README.md
+++ b/README.md
@@ -3,6 +3,8 @@
[](https://badge.fury.io/js/axios-miniprogram)
[](https://opensource.org/licenses/MIT)
+[中文文档](axios-miniprogram.com)
+
## 安装
```bash
@@ -29,543 +31,3 @@ $ npm i axios-miniprogram
- 支持 自定义转换数据。
- 支持 自定义错误处理。
- 支持 自定义平台适配器
-
-## 使用
-
-### 如何引入
-
-```typescript
-// esm
-import axios from 'axios-miniprogram';
-// cjs
-const axios = require('axios-miniprogram');
-// 使用
-axios('/user');
-```
-
-### `axios(config)`
-
-可以通过将相关配置传递给`axios`来发送请求。
-
-```typescript
-// 发送 GET 请求
-axios({
- url: '/user',
- method: 'get',
- params: {
- id: 1,
- },
-})
- .then((response) => {
- // 请求成功后做些什么
- })
- .catch((error) => {
- // 请求失败后做些什么
- });
-
-// 发送 POST 请求
-axios({
- url: '/user',
- method: 'post',
- data: {
- id: 1,
- },
-})
- .then((response) => {
- // 请求成功后做些什么
- })
- .catch((error) => {
- // 请求失败后做些什么
- });
-```
-
-### `axios(url, config?)`
-
-也可以通过直接把`url`传给`axios`来发送请求。
-
-```typescript
-// 默认发送 GET 请求
-axios('/user')
- .then((response) => {
- // 请求成功后做些什么
- })
- .catch((error) => {
- // 请求失败后做些什么
- });
-
-// 发送 POST 请求
-axios('/user', {
- method: 'post',
-})
- .then((response) => {
- // 请求成功后做些什么
- })
- .catch((error) => {
- // 请求失败后做些什么
- });
-```
-
-还可以使用请求方法的别名来简化请求。
-
-- ##### axios.request(config)
-- ##### axios.options(url, config?)
-- ##### axios.get(url, params?, config?)
-- ##### axios.head(url, params?, config?)
-- ##### axios.post(url, data?, config?)
-- ##### axios.put(url, data?, config?)
-- ##### axios.delete(url, params?, config?)
-- ##### axios.trace(url, config?)
-- ##### axios.connect(url, config?)
-
-常用例子，其他同理：
-
-```typescript
-// 发送 GET 请求
-axios.get('/user');
-
-// 携带参数
-axios.get('/user', {
- test: 1,
-});
-
-// 携带额外配置
-axios.get(
- '/user',
- {
- id: 1,
- },
- {
- headers: {
- 'Content-Type': 'application/json; charset=utf-8',
- },
- },
-);
-
-// 发送 POST 请求
-axios.post('/user');
-
-// 携带数据
-axios.post('/user', {
- id: 1,
-});
-
-// 携带额外配置
-axios.post(
- '/user',
- {
- id: 1,
- },
- {
- headers: {
- 'Content-Type': 'application/json; charset=utf-8',
- },
- },
-);
-```
-
-## 动态 URL
-
-您可以使用动态 URL 提高 RESTful API 的书写体验。
-
-```typescript
-axios.get('/user/:id', {
- id: 1,
-});
-
-// url => '/user/1?id=1'
-```
-
-## 配置`config`
-
-非全平台兼容的属性只会在平台支持的情况下生效。
-
-| 参数 | 类型 | 默认值 | 说明 | 全平台兼容 |
-| :---------------- | :-----------------------: | :------------------------------------------------------------------------------------ | :----------------- | :--------- |
-| adapter | Function | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 自定义适配器 | 是 |
-| baseURL | String | | 基础地址 | 是 |
-| url | String | | 请求地址 | 是 |
-| method | String | get | 请求方法 | |
-| params | Object | | 请求参数 | 是 |
-| data | String/Object/ArrayBuffer | | 请求数据 | 是 |
-| headers | Object | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 请求头 | 是 |
-| validateStatus | Function | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 自定义合法状态码 | 是 |
-| paramsSerializer | Function | | 自定义参数序列化 | 是 |
-| transformRequest | Function/Array<.Function> | | 自定义转换请求数据 | 是 |
-| transformResponse | Function/Array<.Function> | | 自定义转换响应数据 | 是 |
-| errorHandler | Function | | 自定义错误处理 | 是 |
-| cancelToken | Object | | 取消令牌 | 是 |
-| timeout | Number | 10000 | 超时时间 | |
-| dataType | String | json | 响应数据格式 | 是 |
-| responseType | String | text | 响应数据类型 | 是 |
-| enableHttp2 | Boolean | false | 开启 http2 | |
-| enableQuic | Boolean | false | 开启 quic | |
-| enableCache | Boolean | false | 开启 cache | |
-| sslVerify | Boolean | true | 验证 ssl 证书 | |
-
-#### `config.method`的合法值
-
-可以使用大写，也可以使用小写。
-
-| 值 | 说明 | 全平台兼容 |
-| :------ | :--- | :--------- |
-| OPTIONS | | |
-| GET | | 是 |
-| HEAD | | |
-| POST | | 是 |
-| PUT | | 是 |
-| DELETE | | 是 |
-| TRACE | | |
-| CONNECT | | |
-
-#### `config.dataType`的合法值
-
-| 值 | 说明 | 全平台兼容 |
-| :--- | :--------------------------------------------------------- | :--------- |
-| json | 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse | 是 |
-| 其他 | 不对返回的内容进行 JSON.parse | 是 |
-
-#### `config.responseType`的合法值
-
-| 值 | 说明 | 全平台兼容 |
-| :---------- | :----------------------- | :--------- |
-| text | 响应的数据为文本 | 是 |
-| arraybuffer | 响应的数据为 ArrayBuffer | 是 |
-
-#### 自定义合法状态码`config.validateStatus`
-
-可以让请求按照您的要求成功或者失败。
-
-```typescript
-axios('/user', {
- validateStatus: function validateStatus(status) {
- // 这样，状态码在 200 到 400 之间都是请求成功
- return status >= 200 && status < 400;
- },
-});
-```
-
-#### 自定义参数序列化`config.paramsSerializer`
-
-可以使用自己的规则去序列化参数。
-
-```typescript
-axios('/user', {
- paramsSerializer: function paramsSerializer(params) {
- return qs.stringify(params, {
- arrayFormat: 'brackets',
- });
- },
-});
-```
-
-#### 自定义转换数据
-
-可以在请求发出之前转换请求数据，在请求成功之后转换响应数据。
-
-```typescript
-axios('/user', {
- transformRequest: [
- function transformRequest(data, headers) {
- // 转换请求数据
- return data;
- },
- ],
- transformResponse: [
- function transformResponse(data) {
- // 转换响应数据
- return data;
- },
- ],
-});
-```
-
-#### 自定义错误处理`config.errorHandler`
-
-可以添加到默认配置中，统一处理错误。
-
-```typescript
-axios.defaults.errorHandler = function errorHandler(error) {
- // 做一些想做的事情
- return Promise.reject(error);
-};
-
-const instance = axios.create({
- errorHandler: function errorHandler(error) {
- // 做一些想做的事情
- return Promise.reject(error);
- },
-});
-```
-
-也可以发送请求时通过自定义配置传入。
-
-```typescript
-axios('/user', {
- errorHandler: function errorHandler(error) {
- // 做一些想做的事情
- return Promise.reject(error);
- },
-});
-```
-
-#### 自定义平台适配器`config.adapter`
-
-您可以手动适配当前所处的平台。
-
-```typescript
-axios.defaults.adapter = function adapter(adapterConfig) {
- const {
- // 请求地址
- url,
- // 请求方法
- method,
- // 请求数据
- data,
- // 请求头 同 headers
- headers,
- // 请求头 同 headers
- headers,
- // 响应数据格式
- dataType,
- // 响应数据类型
- responseType,
- // 超时时间
- timeout,
- // 开启 http2
- enableHttp2,
- // 开启 quic
- enableQuic,
- // 开启 cache
- enableCache,
- // 验证 ssl 证书
- sslVerify,
- // 成功的回调函数
- success,
- // 失败的回调函数
- fail,
- } = adapterConfig;
-
- // 在 adapterConfig 中选择您需要的参数发送请求
- return wx.request({
- url,
- method,
- data,
- headers,
- success,
- fail,
- });
-};
-
-// 如果 adapterConfig 的数据结构适用于当前平台，则可以。
-axios.defaults.adapter = wx.request;
-```
-
-#### 默认配置`defaults`
-
-##### 全局默认配置`axios.defaults`
-
-```typescript
-axios.defaults.baseURL = 'https://www.api.com';
-axios.defaults.headers.common['Accept'] = 'application/json, test/plain, */*';
-axios.defaults.headers.post['Content-Type'] =
- 'application/x-www-form-urlencoded; charset=utf-8';
-```
-
-##### 自定义实例默认配置
-
-可以创建时传入。
-
-```typescript
-const instance = axios.create({
- baseURL: 'https://www.api.com',
- headers: {
- common: {
- Accept: 'application/json, test/plain, */*',
- },
- post: {
- 'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
- },
- },
-});
-```
-
-也可以创建后修改。
-
-```typescript
-instance.defaults.baseURL = 'https://www.api.com';
-instance.defaults.headers.common['Accept'] =
- 'application/json, test/plain, */*';
-instance.defaults.headers.post['Content-Type'] =
- 'application/x-www-form-urlencoded; charset=utf-8';
-```
-
-##### 配置优先顺序
-
-发送请求时，会使用默认配置`defaults`和自定义配置`config`合并出请求配置`requestConfig`，然后用合并出的请求配置`requestConfig`去发送请求，多数情况下，后者优先级要高于前者，具体合并策略可以参考 [mergeConfig.ts](https://github.com/early-autumn/axios-miniprogram/blob/master/src/core/mergeConfig.ts) 的实现。
-
-## 响应体`response`
-
-非全平台兼容的属性只会在平台支持的情况下生效。
-
-| 属性 | 类型 | 说明 | 全平台兼容 |
-| :--------- | :------------------------ | :------------------------------------------- | :--------- |
-| status | Number | 状态码 | 是 |
-| statusText | String | 状态文本 | 是 |
-| data | String/Object/ArrayBuffer | 开发者服务器返回的数据 | 是 |
-| headers | Object | 响应头 | 是 |
-| config | Object | Axios 请求配置 | 是 |
-| cookies | Array<.String> | 开发者服务器返回的 cookies，格式为字符串数组 | |
-| profile | Object | 网络请求过程中一些关键时间点的耗时信息 | |
-
-## API
-
-### `axios.interceptors`
-
-可以先拦截请求或响应，然后再由 then 或 catch 处理。
-
-```typescript
-// 添加请求拦截器
-axios.interceptors.request.use(
- function (config) {
- // 在发送请求之前做些什么
- return config;
- },
- function (error) {
- //处理请求错误
- return Promise.reject(error);
- },
-);
-
-// 添加响应拦截器
-axios.interceptors.response.use(
- function (response) {
- // 请求成功后做些什么
- return response;
- },
- function (error) {
- // 处理响应错误
- return Promise.reject(error);
- },
-);
-```
-
-如果以后需要删除拦截器，则可以。
-
-```typescript
-const myInterceptor = axios.interceptors.request.use(function () {
- // 在发送请求之前做些什么
-});
-axios.interceptors.request.eject(myInterceptor);
-```
-
-还可以将拦截器添加到`axios`的`自定义实例`中。
-
-```typescript
-const myInterceptor = instance.interceptors.request.use(function () {
- // 在发送请求之前做些什么
-});
-instance.interceptors.request.eject(myInterceptor);
-```
-
-### `axios.CancelToken`
-
-可以使用`CancelToken`取消已经发出的请求。
-
-```typescript
-let cancel;
-
-axios('/api', {
- cancelToken: new axios.CancelToken(function (c) {
- cancel = c;
- }),
-});
-
-cancel('取消请求');
-```
-
-还可以使用`CancelToken.source`工厂方法创建`CancelToken`。
-
-```typescript
-const source = axios.CancelToken.source();
-
-axios('/api', {
- cancelToken: source.token,
-});
-
-source.cancel('取消请求');
-```
-
-### `axios.isCancel`
-
-可以判断当前错误是否来自取消请求
-
-```typescript
-axios('/user').catch((error) => {
- if (axios.isCancel(error)) {
- // 请求被取消了
- }
-});
-```
-
-### `axios.getUri(config)`
-
-根据配置中的`url`和`params`生成一个`URI`。
-
-```typescript
-const uri = axios.getUri({
- url: '/user',
- params: {
- id: 1,
- },
-});
-// '/user?id=1'
-```
-
-### `axios.create(defaults)`
-
-创建一个`自定义实例`，传入的自定义默认配置`defaults`会和`axios`的默认配置`axios.defaults`合并成`自定义实例`的默认配置。
-
-`自定义实例`拥有和`axios`相同的调用方式和请求方法的别名。
-
-```typescript
-axios.defaults.baseURL = 'https://www.api.com';
-
-const instance = axios.create({
- params: {
- id: 1,
- },
-});
-
-instance('/user');
-// 'https://www.api.com/user?id=1'
-```
-
-### `axios.Axios`
-
-`axios.Axios`是一个类，其实`axios`就是`axios.Axios`类的实例改造而来的，`axios.create(defaults)`创建的也是`axios.Axios`的实例。
-
-直接实例化`axios.Axios`可以得到一个`原始实例`，不能当函数调用，传入的自定义配置就是`原始实例`的默认配置，而不会像`axios.create(defaults)`一样去合并`axios`中的默认配置。
-
-```typescript
-const instance = new axios.Axios({
- beseURL: 'https://www.api.com',
- params: {
- id: 1,
- },
-});
-
-instance.get('/user');
-// 'https://www.api.com/user?id=1'
-```
-
-## 执行流程
-
-```typescript
-axios('/user').then().catch();
-
-// 请求成功
-// axios => axios.interceptors.request => config.transformRequest => config.paramsSerializer => config.adapter => config.validateStatus => config.transformResponse => axios.interceptors.response => then
-
-// 请求失败
-// axios => axios.interceptors.request => config.transformRequest => config.paramsSerializer => config.adapter => config.validateStatus => config.transformResponse => config.errorHandler => axios.interceptors.response => catch
-```
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index a0ff991..28d9231 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -7,16 +7,43 @@ export default defineConfig({
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
- { text: 'Home', link: '/' },
- { text: 'Examples', link: '/markdown-examples' },
+ { text: '指南', link: '/guide/introduction' },
+ { text: '配置', link: '/config/preview' },
+ { text: 'API', link: '/api/interceptors' },
],
sidebar: [
{
- text: 'Examples',
+ text: '指南',
items: [
- { text: 'Markdown Examples', link: '/markdown-examples' },
- { text: 'Runtime API Examples', link: '/api-examples' },
+ { text: '简介', link: '/guide/introduction' },
+ { text: '快速上手', link: '/guide/quick-start' },
+ ],
+ },
+ {
+ text: '配置',
+ items: [
+ { text: '默认配置', link: '/config/preview' },
+ { text: 'method', link: '/config/method' },
+ { text: 'dataType', link: '/config/data-type' },
+ { text: 'responseType', link: '/config/response-type' },
+ { text: 'validateStatus', link: '/config/validate-status' },
+ { text: 'paramsSerializer', link: '/config/params-serializer' },
+ { text: 'transformRequest', link: '/config/transform-request' },
+ { text: 'transformResponse', link: '/config/transform-response' },
+ { text: 'errorHandler', link: '/config/error-handler' },
+ { text: 'adapter', link: '/config/adapter' },
+ ],
+ },
+ {
+ text: 'API',
+ items: [
+ { text: 'interceptors', link: '/api/interceptors' },
+ { text: 'CancelToken', link: '/api/cancel-token' },
+ { text: 'isCancel', link: '/api/is-cancel' },
+ { text: 'getUri', link: '/api/get-uri' },
+ { text: 'create', link: '/api/create' },
+ { text: 'Axios', link: '/api/axios' },
],
},
],
@@ -24,5 +51,8 @@ export default defineConfig({
socialLinks: [
{ icon: 'github', link: 'https://github.com/zjx0905/axios-miniprogram' },
],
+
+ returnToTopLabel: '返回顶部',
+ outlineTitle: '导航栏',
},
});
diff --git a/docs/api-examples.md b/docs/api-examples.md
deleted file mode 100644
index 6bd8bb5..0000000
--- a/docs/api-examples.md
+++ /dev/null
@@ -1,49 +0,0 @@
----
-outline: deep
----
-
-# Runtime API Examples
-
-This page demonstrates usage of some of the runtime APIs provided by VitePress.
-
-The main `useData()` API can be used to access site, theme, and page data for the current page. It works in both `.md` and `.vue` files:
-
-```md
-
-
-## Results
-
-### Theme Data
-{{ theme }}
-
-### Page Data
-{{ page }}
-
-### Page Frontmatter
-{{ frontmatter }}
-```
-
-
-
-## Results
-
-### Theme Data
-{{ theme }}
-
-### Page Data
-{{ page }}
-
-### Page Frontmatter
-{{ frontmatter }}
-
-## More
-
-Check out the documentation for the [full list of runtime APIs](https://vitepress.dev/reference/runtime-api#usedata).
diff --git a/docs/api/axios.md b/docs/api/axios.md
new file mode 100644
index 0000000..1f8b5ad
--- /dev/null
+++ b/docs/api/axios.md
@@ -0,0 +1,19 @@
+# Axios
+
+## `axios.Axios`
+
+`axios.Axios`是一个类，其实`axios`就是`axios.Axios`类的实例改造而来的，`axios.create(defaults)`创建的也是`axios.Axios`的实例。
+
+直接实例化`axios.Axios`可以得到一个`原始实例`，不能当函数调用，传入的自定义配置就是`原始实例`的默认配置，而不会像`axios.create(defaults)`一样去合并`axios`中的默认配置。
+
+```typescript
+const instance = new axios.Axios({
+ beseURL: 'https://www.api.com',
+ params: {
+ id: 1,
+ },
+});
+
+instance.get('/user');
+// 'https://www.api.com/user?id=1'
+```
diff --git a/docs/api/cancel-token.md b/docs/api/cancel-token.md
new file mode 100644
index 0000000..9a5d423
--- /dev/null
+++ b/docs/api/cancel-token.md
@@ -0,0 +1,29 @@
+# CancelToken
+
+## `axios.CancelToken`取消令牌
+
+可以使用`CancelToken`取消已经发出的请求。
+
+```typescript
+let cancel;
+
+axios('/api', {
+ cancelToken: new axios.CancelToken(function (c) {
+ cancel = c;
+ }),
+});
+
+cancel('取消请求');
+```
+
+还可以使用`CancelToken.source`工厂方法创建`CancelToken`。
+
+```typescript
+const source = axios.CancelToken.source();
+
+axios('/api', {
+ cancelToken: source.token,
+});
+
+source.cancel('取消请求');
+```
diff --git a/docs/api/create.md b/docs/api/create.md
new file mode 100644
index 0000000..7096170
--- /dev/null
+++ b/docs/api/create.md
@@ -0,0 +1,20 @@
+# create
+
+## `axios.create(defaults)`
+
+创建一个`自定义实例`，传入的自定义默认配置`defaults`会和`axios`的默认配置`axios.defaults`合并成`自定义实例`的默认配置。
+
+`自定义实例`拥有和`axios`相同的调用方式和请求方法的别名。
+
+```typescript
+axios.defaults.baseURL = 'https://www.api.com';
+
+const instance = axios.create({
+ params: {
+ id: 1,
+ },
+});
+
+instance('/user');
+// 'https://www.api.com/user?id=1'
+```
diff --git a/docs/api/get-uri.md b/docs/api/get-uri.md
new file mode 100644
index 0000000..94df24e
--- /dev/null
+++ b/docs/api/get-uri.md
@@ -0,0 +1,15 @@
+# getUri
+
+## `axios.getUri(config)`
+
+根据配置中的`url`和`params`生成一个`URI`。
+
+```typescript
+const uri = axios.getUri({
+ url: '/user',
+ params: {
+ id: 1,
+ },
+});
+// '/user?id=1'
+```
diff --git a/docs/api/interceptors.md b/docs/api/interceptors.md
new file mode 100644
index 0000000..ca390d0
--- /dev/null
+++ b/docs/api/interceptors.md
@@ -0,0 +1,49 @@
+# interceptors
+
+## `axios.interceptors`拦截器
+
+可以先拦截请求或响应，然后再由 then 或 catch 处理。
+
+```typescript
+// 添加请求拦截器
+axios.interceptors.request.use(
+ function (config) {
+ // 在发送请求之前做些什么
+ return config;
+ },
+ function (error) {
+ //处理请求错误
+ return Promise.reject(error);
+ },
+);
+
+// 添加响应拦截器
+axios.interceptors.response.use(
+ function (response) {
+ // 请求成功后做些什么
+ return response;
+ },
+ function (error) {
+ // 处理响应错误
+ return Promise.reject(error);
+ },
+);
+```
+
+如果以后需要删除拦截器，则可以。
+
+```typescript
+const myInterceptor = axios.interceptors.request.use(function () {
+ // 在发送请求之前做些什么
+});
+axios.interceptors.request.eject(myInterceptor);
+```
+
+还可以将拦截器添加到`axios`的`自定义实例`中。
+
+```typescript
+const myInterceptor = instance.interceptors.request.use(function () {
+ // 在发送请求之前做些什么
+});
+instance.interceptors.request.eject(myInterceptor);
+```
diff --git a/docs/api/is-cancel.md b/docs/api/is-cancel.md
new file mode 100644
index 0000000..8a4c8e3
--- /dev/null
+++ b/docs/api/is-cancel.md
@@ -0,0 +1,13 @@
+# isCancel
+
+## `axios.isCancel`是否取消
+
+可以判断当前错误是否来自取消请求
+
+```typescript
+axios('/user').catch((error) => {
+ if (axios.isCancel(error)) {
+ // 请求被取消了
+ }
+});
+```
diff --git a/docs/config/adapter.md b/docs/config/adapter.md
new file mode 100644
index 0000000..16dffcb
--- /dev/null
+++ b/docs/config/adapter.md
@@ -0,0 +1,50 @@
+# adapter
+
+## 自定义平台适配器`config.adapter`
+
+您可以手动适配当前所处的平台。
+
+```typescript
+axios.defaults.adapter = function adapter(adapterConfig) {
+ const {
+ // 请求地址
+ url,
+ // 请求方法
+ method,
+ // 请求数据
+ data,
+ // 请求头 同 headers
+ headers,
+ // 请求头 同 headers
+ headers,
+ // 响应数据格式
+ dataType,
+ // 响应数据类型
+ responseType,
+ // 超时时间
+ timeout,
+ // 开启 http2
+ enableHttp2,
+ // 开启 quic
+ enableQuic,
+ // 开启 cache
+ enableCache,
+ // 验证 ssl 证书
+ sslVerify,
+ // 成功的回调函数
+ success,
+ // 失败的回调函数
+ fail,
+ } = adapterConfig;
+
+ // 在 adapterConfig 中选择您需要的参数发送请求
+ return wx.request({
+ url,
+ method,
+ data,
+ headers,
+ success,
+ fail,
+ });
+};
+```
diff --git a/docs/config/data-type.md b/docs/config/data-type.md
new file mode 100644
index 0000000..420ca7b
--- /dev/null
+++ b/docs/config/data-type.md
@@ -0,0 +1,8 @@
+# dataType
+
+## `config.dataType`的合法值
+
+| 值 | 说明 | 全平台兼容 |
+| :--- | :--------------------------------------------------------- | :--------- |
+| json | 返回的数据为 JSON，返回后会对返回的数据进行一次 JSON.parse | 是 |
+| 其他 | 不对返回的内容进行 JSON.parse | 是 |
diff --git a/docs/config/error-handler.md b/docs/config/error-handler.md
new file mode 100644
index 0000000..fea7d42
--- /dev/null
+++ b/docs/config/error-handler.md
@@ -0,0 +1,30 @@
+# errorHandler
+
+## 自定义错误处理`config.errorHandler`
+
+可以添加到默认配置中，统一处理错误。
+
+```typescript
+axios.defaults.errorHandler = function errorHandler(error) {
+ // 做一些想做的事情
+ return Promise.reject(error);
+};
+
+const instance = axios.create({
+ errorHandler: function errorHandler(error) {
+ // 做一些想做的事情
+ return Promise.reject(error);
+ },
+});
+```
+
+也可以发送请求时通过自定义配置传入。
+
+```typescript
+axios('/user', {
+ errorHandler: function errorHandler(error) {
+ // 做一些想做的事情
+ return Promise.reject(error);
+ },
+});
+```
diff --git a/docs/config/method.md b/docs/config/method.md
new file mode 100644
index 0000000..281e3a5
--- /dev/null
+++ b/docs/config/method.md
@@ -0,0 +1,16 @@
+# method
+
+## `config.method`的合法值
+
+可以使用大写，也可以使用小写。
+
+| 值 | 说明 | 全平台兼容 |
+| :------ | :--- | :--------- |
+| OPTIONS | | |
+| GET | | 是 |
+| HEAD | | |
+| POST | | 是 |
+| PUT | | 是 |
+| DELETE | | 是 |
+| TRACE | | |
+| CONNECT | | |
diff --git a/docs/config/params-serializer.md b/docs/config/params-serializer.md
new file mode 100644
index 0000000..dd6d6cc
--- /dev/null
+++ b/docs/config/params-serializer.md
@@ -0,0 +1,15 @@
+# paramsSerializer
+
+## 自定义参数序列化`config.paramsSerializer`
+
+可以使用自己的规则去序列化参数。
+
+```typescript
+axios('/user', {
+ paramsSerializer: function paramsSerializer(params) {
+ return qs.stringify(params, {
+ arrayFormat: 'brackets',
+ });
+ },
+});
+```
diff --git a/docs/config/preview.md b/docs/config/preview.md
new file mode 100644
index 0000000..b967225
--- /dev/null
+++ b/docs/config/preview.md
@@ -0,0 +1,69 @@
+# 默认配置
+
+## 全局默认配置`axios.defaults`
+
+```typescript
+axios.defaults.baseURL = 'https://www.api.com';
+axios.defaults.headers.common['Accept'] = 'application/json, test/plain, */*';
+axios.defaults.headers.post['Content-Type'] =
+ 'application/x-www-form-urlencoded; charset=utf-8';
+```
+
+## 自定义实例默认配置
+
+可以创建时传入。
+
+```typescript
+const instance = axios.create({
+ baseURL: 'https://www.api.com',
+ headers: {
+ common: {
+ Accept: 'application/json, test/plain, */*',
+ },
+ post: {
+ 'Content-Type': 'application/x-www-form-urlencoded; charset=utf-8',
+ },
+ },
+});
+```
+
+也可以创建后修改。
+
+```typescript
+instance.defaults.baseURL = 'https://www.api.com';
+instance.defaults.headers.common['Accept'] =
+ 'application/json, test/plain, */*';
+instance.defaults.headers.post['Content-Type'] =
+ 'application/x-www-form-urlencoded; charset=utf-8';
+```
+
+## 配置优先顺序
+
+发送请求时，会使用默认配置`defaults`和自定义配置`config`合并出请求配置`requestConfig`，然后用合并出的请求配置`requestConfig`去发送请求，多数情况下，后者优先级要高于前者，具体合并策略可以参考 [mergeConfig.ts](https://github.com/early-autumn/axios-miniprogram/blob/master/src/core/mergeConfig.ts) 的实现。
+
+## 配置表
+
+非全平台兼容的属性只会在平台支持的情况下生效。
+
+| 参数 | 类型 | 默认值 | 说明 | 全平台兼容 |
+| :---------------- | :-----------------------: | :------------------------------------------------------------------------------------ | :----------------- | :--------- |
+| adapter | Function | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 自定义适配器 | 是 |
+| baseURL | String | | 基础地址 | 是 |
+| url | String | | 请求地址 | 是 |
+| method | String | get | 请求方法 | |
+| params | Object | | 请求参数 | 是 |
+| data | String/Object/ArrayBuffer | | 请求数据 | 是 |
+| headers | Object | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 请求头 | 是 |
+| validateStatus | Function | [查看](https://github.com/early-autumn/axios-miniprogram/blob/master/src/defaults.ts) | 自定义合法状态码 | 是 |
+| paramsSerializer | Function | | 自定义参数序列化 | 是 |
+| transformRequest | Function/Array\ | | 自定义转换请求数据 | 是 |
+| transformResponse | Function/Array\ | | 自定义转换响应数据 | 是 |
+| errorHandler | Function | | 自定义错误处理 | 是 |
+| cancelToken | Object | | 取消令牌 | 是 |
+| timeout | Number | 10000 | 超时时间 | |
+| dataType | String | json | 响应数据格式 | 是 |
+| responseType | String | text | 响应数据类型 | 是 |
+| enableHttp2 | Boolean | false | 开启 http2 | |
+| enableQuic | Boolean | false | 开启 quic | |
+| enableCache | Boolean | false | 开启 cache | |
+| sslVerify | Boolean | true | 验证 ssl 证书 | |
diff --git a/docs/config/response-type.md b/docs/config/response-type.md
new file mode 100644
index 0000000..b9ffdf5
--- /dev/null
+++ b/docs/config/response-type.md
@@ -0,0 +1,8 @@
+# responseType
+
+## `config.responseType`的合法值
+
+| 值 | 说明 | 全平台兼容 |
+| :---------- | :----------------------- | :--------- |
+| text | 响应的数据为文本 | 是 |
+| arraybuffer | 响应的数据为 ArrayBuffer | 是 |
diff --git a/docs/config/transform-request.md b/docs/config/transform-request.md
new file mode 100644
index 0000000..35de710
--- /dev/null
+++ b/docs/config/transform-request.md
@@ -0,0 +1,16 @@
+# transformRequest
+
+## `config.transformRequest`自定义转换请求数据
+
+可以在请求发出之前转换请求数据。
+
+```typescript
+axios('/user', {
+ transformRequest: [
+ function transformRequest(data, headers) {
+ // 转换请求数据
+ return data;
+ },
+ ],
+});
+```
diff --git a/docs/config/transform-response.md b/docs/config/transform-response.md
new file mode 100644
index 0000000..aed60dd
--- /dev/null
+++ b/docs/config/transform-response.md
@@ -0,0 +1,16 @@
+# transformResponse
+
+## `config.transformResponse`自定义转换响应数据
+
+可以在请求发出之前转换请求数据。
+
+```typescript
+axios('/user', {
+ transformResponse: [
+ function transformResponse(data, headers) {
+ // 转换请求数据
+ return data;
+ },
+ ],
+});
+```
diff --git a/docs/config/validate-status.md b/docs/config/validate-status.md
new file mode 100644
index 0000000..3f65704
--- /dev/null
+++ b/docs/config/validate-status.md
@@ -0,0 +1,14 @@
+# validateStatus
+
+## 自定义合法状态码`config.validateStatus`
+
+可以让请求按照您的要求成功或者失败。
+
+```typescript
+axios('/user', {
+ validateStatus: function validateStatus(status) {
+ // 这样，状态码在 200 到 400 之间都是请求成功
+ return status >= 200 && status < 400;
+ },
+});
+```
diff --git a/docs/guide/introduction.md b/docs/guide/introduction.md
new file mode 100644
index 0000000..9affc00
--- /dev/null
+++ b/docs/guide/introduction.md
@@ -0,0 +1,26 @@
+---
+title: 简介
+sidebarDepth: 1
+lastUpdated: true
+sitemap:
+ priority: 0.8
+---
+
+# 简介
+
+## 什么是 axios-miniprogram
+
+axios-miniprogram 是一款为小程序平台量身定制的轻量级请求库，支持跨平台使用，同时也支持多种导入方式，可用于原生小程序项目，也可用于第三方框架项目，用法上同 [axios](git@github.com:axios/axios.git) 类似。
+
+## 特性
+
+- 支持 微信小程序、支付宝小程序、百度小程序、字节跳动小程序、QQ 小程序、uniapp。
+- 支持 `Typescript`，健全的类型系统，智能的 `IDE` 提示。
+- 支持 `Promise`。
+- 支持 拦截器。
+- 支持 取消请求。
+- 支持 自定义合法状态码。
+- 支持 自定义参数序列化。
+- 支持 自定义转换数据。
+- 支持 自定义错误处理。
+- 支持 自定义平台适配器
diff --git a/docs/guide/quick-start.md b/docs/guide/quick-start.md
new file mode 100644
index 0000000..405faa1
--- /dev/null
+++ b/docs/guide/quick-start.md
@@ -0,0 +1,184 @@
+---
+title: 快速上手
+sidebarDepth: 1
+lastUpdated: true
+sitemap:
+ priority: 0.8
+---
+
+# 快速上手
+
+## 安装
+
+:::: code-group
+
+```sh [NPM]
+npm install -D axios-miniprogram
+```
+
+```sh [YARN]
+yarn add -D axios-miniprogram
+```
+
+```sh [PNPM]
+pnpm install -D axios-miniprogram
+```
+
+::::
+
+## 使用
+
+### 如何引入
+
+```typescript
+// esm
+import axios from 'axios-miniprogram';
+// cjs
+const axios = require('axios-miniprogram');
+// 使用
+axios('/user');
+```
+
+### `axios(config)`
+
+可以通过将相关配置传递给`axios`来发送请求。
+
+```typescript
+// 发送 GET 请求
+axios({
+ url: '/user',
+ method: 'get',
+ params: {
+ id: 1,
+ },
+})
+ .then((response) => {
+ // 请求成功后做些什么
+ })
+ .catch((error) => {
+ // 请求失败后做些什么
+ });
+
+// 发送 POST 请求
+axios({
+ url: '/user',
+ method: 'post',
+ data: {
+ id: 1,
+ },
+})
+ .then((response) => {
+ // 请求成功后做些什么
+ })
+ .catch((error) => {
+ // 请求失败后做些什么
+ });
+```
+
+### `axios(url, config?)`
+
+也可以通过直接把`url`传给`axios`来发送请求。
+
+```typescript
+// 默认发送 GET 请求
+axios('/user')
+ .then((response) => {
+ // 请求成功后做些什么
+ })
+ .catch((error) => {
+ // 请求失败后做些什么
+ });
+
+// 发送 POST 请求
+axios('/user', {
+ method: 'post',
+})
+ .then((response) => {
+ // 请求成功后做些什么
+ })
+ .catch((error) => {
+ // 请求失败后做些什么
+ });
+```
+
+还可以使用请求方法的别名来简化请求。
+
+- ##### axios.request(config)
+- ##### axios.options(url, config?)
+- ##### axios.get(url, params?, config?)
+- ##### axios.head(url, params?, config?)
+- ##### axios.post(url, data?, config?)
+- ##### axios.put(url, data?, config?)
+- ##### axios.delete(url, params?, config?)
+- ##### axios.trace(url, config?)
+- ##### axios.connect(url, config?)
+
+常用例子，其他同理：
+
+```typescript
+// 发送 GET 请求
+axios.get('/user');
+
+// 携带参数
+axios.get('/user', {
+ test: 1,
+});
+
+// 携带额外配置
+axios.get(
+ '/user',
+ {
+ id: 1,
+ },
+ {
+ headers: {
+ 'Content-Type': 'application/json; charset=utf-8',
+ },
+ },
+);
+
+// 发送 POST 请求
+axios.post('/user');
+
+// 携带数据
+axios.post('/user', {
+ id: 1,
+});
+
+// 携带额外配置
+axios.post(
+ '/user',
+ {
+ id: 1,
+ },
+ {
+ headers: {
+ 'Content-Type': 'application/json; charset=utf-8',
+ },
+ },
+);
+```
+
+## 动态 URL
+
+您可以使用动态 URL 提高 RESTful API 的书写体验。
+
+```typescript
+axios.get('/user/:id', {
+ id: 1,
+});
+```
+
+## 响应体`response`
+
+非全平台兼容的属性只会在平台支持的情况下生效。
+
+| 属性 | 类型 | 说明 | 全平台兼容 |
+| :--------- | :------------------------ | :------------------------------------------- | :--------- |
+| status | Number | 状态码 | 是 |
+| statusText | String | 状态文本 | 是 |
+| data | String/Object/ArrayBuffer | 开发者服务器返回的数据 | 是 |
+| headers | Object | 响应头 | 是 |
+| config | Object | Axios 请求配置 | 是 |
+| cookies | Array<.String> | 开发者服务器返回的 cookies，格式为字符串数组 | |
+| profile | Object | 网络请求过程中一些关键时间点的耗时信息 | |
diff --git a/docs/index.md b/docs/index.md
index 7b6b02e..8ae4f48 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -3,23 +3,22 @@
layout: home
hero:
- name: "axios-miniprogram"
- text: "基于 Promise 的 HTTP 请求库，适用于各大小程序平台。"
+ name: 'axios-miniprogram'
+ text: '基于 Promise 的 HTTP 请求库，适用于各大小程序平台。'
tagline: My great project tagline
actions:
- theme: brand
- text: Markdown Examples
- link: /markdown-examples
+ text: 介绍
+ link: /guide/introduction
- theme: alt
- text: API Examples
- link: /api-examples
+ text: 安装
+ link: /guide/quick-start
features:
- - title: Feature A
- details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- - title: Feature B
- details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
- - title: Feature C
- details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+ - title: 轻量
+ details: 不足 10kb
+ - title: 跨平台
+ details: 兼容各个小程序
+ - title: 方便
+ details: 任何形式的项目都可使用
---
-
diff --git a/docs/markdown-examples.md b/docs/markdown-examples.md
deleted file mode 100644
index 8e55eb8..0000000
--- a/docs/markdown-examples.md
+++ /dev/null
@@ -1,85 +0,0 @@
-# Markdown Extension Examples
-
-This page demonstrates some of the built-in markdown extensions provided by VitePress.
-
-## Syntax Highlighting
-
-VitePress provides Syntax Highlighting powered by [Shiki](https://github.com/shikijs/shiki), with additional features like line-highlighting:
-
-**Input**
-
-````
-```js{4}
-export default {
- data () {
- return {
- msg: 'Highlighted!'
- }
- }
-}
-```
-````
-
-**Output**
-
-```js{4}
-export default {
- data () {
- return {
- msg: 'Highlighted!'
- }
- }
-}
-```
-
-## Custom Containers
-
-**Input**
-
-```md
-::: info
-This is an info box.
-:::
-
-::: tip
-This is a tip.
-:::
-
-::: warning
-This is a warning.
-:::
-
-::: danger
-This is a dangerous warning.
-:::
-
-::: details
-This is a details block.
-:::
-```
-
-**Output**
-
-::: info
-This is an info box.
-:::
-
-::: tip
-This is a tip.
-:::
-
-::: warning
-This is a warning.
-:::
-
-::: danger
-This is a dangerous warning.
-:::
-
-::: details
-This is a details block.
-:::
-
-## More
-
-Check out the documentation for the [full list of markdown extensions](https://vitepress.dev/guide/markdown).
diff --git a/docs/tsconfig.json b/docs/tsconfig.json
index 53538a9..883a473 100644
--- a/docs/tsconfig.json
+++ b/docs/tsconfig.json
@@ -1,4 +1,5 @@
{
+ "extends": "../tsconfig.json",
"compilerOptions": {
"baseUrl": ".",
"module": "esnext",
@@ -18,7 +19,8 @@
"include": [
"./.vitepress/**/*.ts",
"./.vitepress/**/*.vue",
- "./.vitepress/components.d.ts"
+ "./.vitepress/components.d.ts",
+ "../global.d.ts"
],
"exclude": ["dist", "node_modules"]
}