apiRequestByHighway(params: Object)

版本要求:
MiniKit≥2.3.6@ray-js/ray≥0.5.9
支持平台:
iOSAndroid
import { apiRequestByHighway } from '@ray-js/ray';

// Promise 调用
try {
  const res = await apiRequestByHighway({ ...params });
  console.log(res);
} catch (err) {
  console.log(err.errorMsg);
}

描述

发起highway请求

参数

属性类型必填默认值说明MiniKit 最低版本
apistring是-api 名称-
否-Highway API 请求业务参数，字段结构由 api 对应的 Highway 接口定义-
method"OPTIONS" | "GET" | "HEAD" | "POST" | "PUT" | "DELETE" | "TRACE" | "CONNECT"否'GET'method 请求方法-
requestIdstring否-requestId 请求ID，业务方不感知v3.27.0
否-cache 缓存配置v3.27.0
complete() => void否-接口调用结束的回调函数（调用成功、失败都会执行）-
success(params: Object) => void否-接口调用成功的回调函数-
fail(params: Object) => void否-接口调用失败的回调函数-
success 回调参数
属性类型说明MiniKit 最低版本
接口返回的原始数据v3.2.0
fail 回调参数
属性类型说明
errorMsgstring错误信息
errorCodestring | number错误码
错误扩展

返回值

无

合法值

method
值说明MiniKit 最低版本
GETHTTP 请求 GETv3.4.0
POSTHTTP 请求 POSTv3.4.0
PUTHTTP 请求 PUTv3.4.0
DELETEHTTP 请求 DELETEv3.4.0
ApiRequestCacheBean.policy
值说明MiniKit 最低版本
NETWORK_ONLY仅发起网络请求，不使用缓存v4.24.0
CACHE_ELSE_NETWORK先使用缓存，缓存不存在时发起网络请求v4.24.0
CACHE_THEN_NETWORK优先使用缓存，同时发起网络请求，网络请求结果会通过事件下发v4.24.0

示例代码

import { apiRequestByHighway } from '@ray-js/ray'

// Highway RESTful request: api is a "/v1.0/..." url, method is GET/POST,
// data depends on the specific highway api. (Real usage from @ray-js/ray miniapps.)
apiRequestByHighway({
  api: "/v1.0/m/tc/album/pic/batch/download/url",
  method: "POST",
  data: {},
  success: data => {
    console.log(data);
  },
  fail: error => {
    console.error(error);
  },
});