API
Component

ApiRequest ($UI/comp/apiRequest/components/apiRequest/apiRequest)

使用范围：WX

Contents

component ApiRequest ($UI/comp/apiRequest/components/apiRequest/apiRequest) extends Component

API请求组件

<b>使用场景</b>：发送API请求。 <b>使用方法</b>：选择openapi进行发送。

Constructor Top

  ApiRequest ()
  ApiRequest ( config)

Properties Top

String operationId

操作标识

Attributes Top

String operationId

操作标识
String serviceName

OpenAPI

Methods Top

Res send ($UI/wxsys/JSON params)

Operations Top

void send (object params)
void send (object params)

Events Top

void error (ErrorEvent event)
void error (BeforeRequestEvent event, ErrorEvent event)
void success (SuccessEvent event)

Constructor details Top

public ApiRequest ()

API请求组件

<b>使用场景</b>：发送API请求。 <b>使用方法</b>：选择openapi进行发送。

public ApiRequest ( config)

构造函数

Inherited from Operational

Parameters

config

操作配置

Properties Detail Top

public String operationId

操作标识

Attributes Detail Top

public String operationId

操作标识

public String serviceName

OpenAPI

Methods Detail Top

public Res send ($UI/wxsys/JSON params)

发送OpenAPI请求.

Parameters

$UI/wxsys/JSON params

参数

扩展类型：apiRequest#param

Return Value

Res

Operations Detail Top

public void send (object params)

发送OpenAPI请求

Parameters

object params

参数

Return Value

void

public void send (object params)

发送OpenAPI请求

Parameters

object params

参数

Return Value

void

Events Detail Top

public void error (ErrorEvent event)

[回调型事件]请求失败事件

Parameters

ErrorEvent event


结构如下：

{ "source" : 组件的对象, "request": { "params": 参数, "data": 发送数据, "header": 请求头 }, "error": 错误信息, "docUrl": doc文档地址, "operationId": 操作标识 }

Return Value

void

public void error (BeforeRequestEvent event, ErrorEvent event)

[回调型事件]请求失败事件

Parameters

BeforeRequestEvent event

/**
ErrorEvent event


结构如下：

{ "source" : 组件的对象, "request": { "params": 参数, "data": 发送数据, "header": 请求头 }, "cancel": false, "docUrl": doc文档地址, "operationId": 操作标识 }

Return Value

void

public void success (SuccessEvent event)

[回调型事件]请求成功事件

Parameters

SuccessEvent event


结构如下：

{ "source" : 组件的对象, "request": { "params": 参数, "data": 发送数据, "header": 请求头 }, "response": { "header": 返回头, "data": 返回数据 "status": 返回状态 }, "docUrl": doc文档地址, "operationId": 操作标识 }

Return Value

void