gdin-request
v0.1.18
Published
基于`umi-request`的网络请求库,返回格式默认是`{code, data, msg}` <br/> 常用方法有:`get` `post` `put` `delete` 等等,并添加了 `form` `update` `download` 三个方法
Downloads
19
Readme
gdin-request
基于umi-request
的网络请求库,返回格式默认是{code, data, msg}
常用方法有:get
post
put
delete
等等,并添加了 form
update
download
三个方法
安装
npm install --save gdin-request
or
yarn add gdin-request
引入
import request from 'gdin-request'
初始化配置项
// 接口前缀, 默认是空
request.base.prefix = '/api';
// 超时设置
request.base.timeout = 12000;
// 请求数据返回格式,default是{code, data, msg}; simple是直接返回data,异常情况在catch中捕获
request.base.dataMode = 'default';
// headers中的鉴权值authorization
request.base.getAuthorization = function() {
return '';
};
// 拦截错误情况
request.base.interceptError = function(error) {
return true;
};
或者调用初始化方法初始配置项
request.init({
prefix: '/api',
timeout: 12000,
dataMode: 'simple',
getAuthorization: () => {
return 'Basic dGVzdDp0ZXN0';
},
interceptError: error => {
return true;
},
});
Request 配置项说明:
| 字段名 | 值类型 | 说明 | 默认值 | | ---------------- | -------- | ----------------------------------------------------------------------------------------------- | ---------- | | prefix | string | 接口前缀 | | | timeout | number | 超时设置 | 12000 | | dataMode | string | 请求数据返回格式,default 是{code, data, msg}; simple 是直接返回 data,异常情况在 catch 中捕获 | default | | getAuthorization | function | headers 中的鉴权值 authorization | | | interceptError | function | 拦截错误情况 | () => true |
一般用法
- content-type 默认是
application/json
- method:GET、POST、PUT、DELETE、HEAD、OPTION、UPDATE、DOWNLOAD 等等
- params:会拼接在 url 上面,是 url 参数
- data:是请求体 body 内容
request('/test/save', { method: 'POST', data: { name: '123' } });
request('/test/list', { params: { area: 1 } });
内置封装方法
- request.get
- request.post
- request.put
- request.delete
- request.form
- request.upload
- request.download
form 表单提交
是 POST 请求,并自动将请求头的中 content-type 改为application/x-www-form-urlencoded
upload 上传
是POST
请求
request.upload(url, options);
options 参数说明:
| 字段名 | 类型 | 说明 | | ----------- | -------- | ---------------------------------- | | headers | object | 请求头信息 | | params | object | url 参数 | | data | object | 请求体内容 | | onLoadStart | Function | 请求开始 | | onProgress | Function | 上传进度条监听函数,返回值是 0-100 |
download 下载
默认是GET
请求,可在options
中添加method
指定其他请求类型,其他同 upload