Axios 剪辑器
这个库提供了Axios周围的方便包装器,增加了自动取消同时提出的请求 它的特征.
安装
npm install --save-dev @gravity-ui/axios-wrapper
HTTP API 密码
构造参数
配置 [可选]
一个 axios 举个例子.
收藏器 [可选]
请求收藏器的配置是一个对象:
{
"collectErrors": 10,
"collectRequests": 10
}
基本方法
Wrapper 提供 http- 方法 get, (中文(简体) ), head, (中文(简体) ), put, (中文(简体) ), post, (中文(简体) ), delete。 。 。 .
方法 get 财务报告和审定财务报表 head 有签名 (url, params, options)· ; put, (中文(简体) ), post,则 delete 方法
已经 (url, data, params, options) 签名.
这个 params 参数表示查询字符串参数时 options 是请求设置.
目前支持4个请求设置 :
concurrentId (string): 可选请求编号collectRequest (bool): 可选标记, 显示请求是否为日志( 默认)true(中文(简体) )requestConfig (object): 可选配置自定义请求参数headers (object): 带有自定义请求头的可选对象.timeout (number): 可选请求超时onDownloadProgress (function): 处理文件下载进度的可选回调
页眉
这个 setDefaultHeader({name (string), value (string), methods (array)}) 方法允许添加默认
请求头.
参数 name 财务报告和审定财务报表 value 需要,可选参数 methods 指定所有获取这些方法的方法
默认信头(默认所有方法都会得到这些信头).
中国证监会
这个 setCSRFToken 方法允许指定 CSRF- token, 它将添加到所有 put, (中文(简体) ), post 财务报告和审定财务报表 delete
请求.
同时提出的请求
有时,如果不再需要飞行结果,最好取消飞行中的请求。 来做这个
发生的时候,人们应该通过请求 options 页:1 concurrentId 编号. 当下一个相同的请求
concurrentId 发生上一个请求,该 id 将被取消.
也通过援引 cancelRequest(concurrentId) 方法.
收集请求
可以使用 collector 选项。 它储存
所有要求和错误都分开。 以下内容: apiInstance 将保留最后10项请求(均成功)
以及最后10项错误请求.
const apiInstance = new API({
collector: {
collectErrors: 10,
collectRequests: 10
}
});
要得到保存的请求,必须引用 getCollectedRequests 返回对象的方法
{errors: [...], requests: [...]}。 。 。 .
使用量
建议的用法是把基地细分 AxiosWrapper 类 :
export class API extends AxiosWrapper {
getProjects() {
return this.get('/projects');
}
getSensors({project, selectors}) {
return this.get(`/projects/${project}/sensors`, {selectors, pageSize: 200});
}
getNames({project, selectors}) {
return this.get(`/projects/${project}/sensors/names`, {selectors});
}
getLabels({project, names, selectors}) {
return this.get(`/projects/${project}/sensors/labels`, {names, selectors});
}
}
当 baseURL 参数传入 axios 配置, 所有请求的路径名将附在其中 .
const apiInstance = new API({
config: {
baseURL: '/api/v2'
}
});