tencent cloud

文档反馈

发起请求

最后更新时间:2024-03-05 14:58:40

    request

    该 API 使用方法为 RequestTask wx.request(Object object)
    功能说明:发起 HTTPS 网络请求。使用前请注意阅读 相关说明
    参数及说明:Object object。
    属性
    类型
    默认值
    必填
    说明
    url
    string
    -
    开发者服务器接口地址
    data
    string/object/ArrayBuffer
    -
    请求的参数
    header
    Object
    -
    设置请求的 header,header 中不能设置 Referer。content-type 默认为 application/json
    method
    string
    GET
    HTTP 请求方法
    dataType
    string
    json
    返回的数据格式
    responseType
    string
    text
    响应的数据类型
    success
    function
    -
    接口调用成功的回调函数
    fail
    function
    -
    接口调用失败的回调函数
    complete
    function
    -
    接口调用结束的回调函数(调用成功、失败都会执行)
    object.method 的合法值:
    说明
    OPTIONS
    HTTP 请求 OPTIONS
    GET
    HTTP 请求 GET
    HEAD
    HTTP 请求 HEAD
    POST
    HTTP 请求 POST
    PUT
    HTTP 请求 PUT
    DELETE
    HTTP 请求 DELETE
    TRACE
    HTTP 请求 TRACE
    CONNECT
    HTTP 请求 CONNECT
    object.dataType 的合法值:
    说明
    json
    返回的数据为 JSON,返回后会对返回的数据进行一次 JSON.parse
    其他
    不对返回的内容进行 JSON.parse
    object.responseType 的合法值
    说明
    text
    响应的数据为文本
    arraybuffer
    响应的数据为 ArrayBuffer
    object.success 回调函数参数:Object res
    属性
    类型
    说明
    data
    string/Object/Arraybuffer
    开发者服务器返回的数据
    statusCode
    number
    开发者服务器返回的 HTTP 状态码
    header
    Object
    开发者服务器返回的 HTTP Response Header
    返回值:RequestTask,请求任务对象。
    data 参数说明:
    最终发送给服务器的数据是 String 类型,如果传入的 data 不是 String 类型,会被转换成 String。转换规则如下:
    对于 GET 方法的数据,会将数据转换成 query string(encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...
    对于 POST 方法且 header['content-type']application/json的数据,会对数据进行 JSON 序列化。
    对于 POST 方法且 header['content-type']application/x-www-form-urlencoded 的数据,会将数据转换成 query string (encodeURIComponent(k)=encodeURIComponent(v)&encodeURIComponent(k)=encodeURIComponent(v)...)
    示例代码:
    wx.request({
    url: 'test.php', // 仅为示例,并非真实的接口地址
    data: {
    x: '',
    y: ''
    },
    header: {
    'content-type': 'application/json' // 默认值
    },
    success(res) {
    console.log(res.data)
    }
    })

    RequestTask

    .abort

    该 方法 使用方式为 RequestTask.abort()
    功能说明:中断请求任务。

    .onChunkReceived

    该 方法 使用方式为 RequestTask.onChunkReceived(function listener)
    功能说明:监听 Transfer-Encoding Chunk Received 事件。当接收到新的chunk时触发。
    参数及说明:Object res 参数,function listener,Transfer-Encoding Chunk Received 事件的监听函数。
    属性
    类型
    说明
    res
    Object
    开发者服务器每次返回新 chunk 时的 Response
    res 结构属性
    结构属性
    类型
    说明
    data
    ArrayBuffer
    返回的 chunk buffer

    .offChunkReceived

    该 方法 使用方式为 RequestTask.offChunkReceived(function listener)
    功能说明:移除 Transfer-Encoding Chunk Received 事件的监听函数。
    参数及说明:function listener,onChunkReceived 传入的监听函数,不传此参数则移除所有监听函数。
    示例代码
    const listener = function (res) { console.log(res) }
    
    RequestTask.onChunkReceived(listener)
    RequestTask.offChunkReceived(listener) // 需传入与监听时同一个的函数对象

    .onHeadersReceived

    该 方法 使用方式为 RequestTask.onHeadersReceived(function listener)
    功能说明:移除 HTTP Response Header 事件的监听函数。
    参数及说明:function listener,onHeadersReceived 传入的监听函数,不传此参数则移除所有监听函数。
    示例代码:
    const listener = function (res) { console.log(res) }
    
    RequestTask.onHeadersReceived(listener)
    RequestTask.offHeadersReceived(listener) // 需传入与监听时同一个的函数对象

    .offHeadersReceived

    该 方法 使用方式为 RequestTask.offHeadersReceived(function listener)
    功能说明:监听 HTTP Response Header 事件。会比请求完成事件更早。
    参数及说明:function listener,HTTP Response Header 事件的监听函数。
    属性
    类型
    说明
    header
    Object
    开发者服务器返回的 HTTP Response Header
    
    联系我们

    联系我们,为您的业务提供专属服务。

    技术支持

    如果你想寻求进一步的帮助,通过工单与我们进行联络。我们提供7x24的工单服务。

    7x24 电话支持