universal-request

API

import request from '@aliretail/react-universal-request';
const res = request(options);

options 参数对象

| 参数名 | 类型 | 描述 | 默认值 | | -------------------- | ------- | ----------------------------------- | ------------------------------------------------ | | appCode | string | 应用 code 或相对路径 | | | apiCode | string | API code | | | type | string | html, xml, json, or jsonp | | | contentType | string | | 当 method 为 post 时，默认值为application/json | | method | string | 请求方法 | get | | headers | object | 请求头 | 默认会加 X-XSRF-TOKEN | | data | object | post 请求参数对象 | | | params | object | get 请求参数对象 | | | url | string | 请求的全 url | | | autoShowErrorMessage | boolean | 是否在请求失败时自动弹提示 | false | | csrf | boolean | 是否需要在 header 中添加 CSRF token | false | | responseHandler | func | 自定义返回值处理函数 | |

请求接口规范

• 请求返回的数据中包含success字段时，只有其值为 true 才会 resolve
• 如果没有success字段，则判断errorMessage或message字段，如果其值为空，则为 resolve
• 其他场景都为 reject
• 用户可以通过添加responseHandler先将返回值处理为满足上述 resolve 规则的结构

setLocalApiPrefix

设置本地测试时的请求 url 前缀

(prefix: string) => void

getApiUrl

获取 API 地址

/**
 * 获取请求地址
 * @param appCode 应用的code或完整的api路径
 * @param apiCode API code
 */
(appCode: string, apiCode: string) => string;