请求

request

解释:发起网络请求

方法参数:Object

Object 参数说明:

参数名类型必填默认值说明
urlString-开发者服务器接口地址
dataObject/String-请求的参数
headerObject-设置请求的 header,header 中不能设置 Referer。
methodStringGET (大写)有效值:OPTIONS, GET, HEAD, POST, PUT, DELETE 。
dataTypeStringjson有效值:string,json。 如果设为 json,会尝试对返回的数据做一次 JSON.parse 。
responseTypeStringtext设置响应的数据类型, 合法值:text、arraybuffer。
successFunction-收到开发者服务成功返回的回调函数。
failFunction-接口调用失败的回调函数。
completeFunction-接口调用结束的回调函数(调用成功、失败都会执行)。

success 返回参数说明:

参数类型说明
dataObject/String开发者服务器返回的数据
statusCodeNumber开发者服务器返回的 HTTP 状态码
headerObject开发者服务器返回的 HTTP Response Header

data 数据说明:

最终发送给服务器的数据都是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String 。转换规则如下:1、对于 GET 方法的数据,会将数据转换成 query string(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)…);2、对于 POST 方法且 header[‘content-type’] 为 application/json 的数据,会对数据进行 JSON 序列化;3、对于 POST 方法且 header[‘content-type’] 为 application/x-www-form-urlencoded 的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)…)。

示例 1在开发者工具中预览效果

  1. swan.request({
    url: 'https://smartprogram.baidu.com/xxx', // 仅为示例,并非真实的接口地址
    method: 'GET',
    dataType: 'json',
    data: {
    key: 'value'
    },
    header: {
    'content-type': 'application/json' // 默认值
    },
    success: function (res) {
    console.log(res.data);
    },
    fail: function (err) {
    console.log('错误码:' + err.errCode);
    console.log('错误信息:' + err.errMsg);
    }
    });

返回值:

返回一个 requestTask 对象,通过 requestTask,可中断请求任务。

requestTask 对象的方法列表:

方法参数说明
abort中断请求任务

示例 2

  1. const requestTask = swan.request({
    url: 'test.php', //仅为示例,并非真实的接口地址
    data: {
    x: '' ,
    y: ''
    },
    header: {
    'content-type': 'application/json'
    },
    success: function(res) {
    console.log(res.data)
    }
    });
    //取消请求任务
    requestTask.abort();

说明

  • content-type 默认为 ‘application/json’;
  • url 中不能有端口。

使用注意事项上传、下载